MacroView DMS and DMS Pro version 8.5.1097 and later has support for setting a central location to update the configuration files stored in your MacroView user settings* folder.
This is great news for system administrators, allowing them to deploy user settings to all members in their organisation with the click of a button.
How it works
You can store your configuration files such as 'TreeNodesToHide.xml', localisation files and other configuration files for DMS plug-ins in a central (common) location in SharePoint and set up your user's DMS client to retrieve these files from that central location.
This will save you time from having to manually deploy common user settings to each individual machine or risk users making an error if installing it themselves.
The following are just a few of the configuration files currently supported.
- TreeNodesTohide.xml
- MacroView Case and Matter - Create Matter
- MacroView Project - Create Projects
- MacroView Solution Provisioning
- MacroView DMS and DMS Pro extension configurations
- Language resource files (rebranding)
- Default Person/Group
- Map Folder Name to field Value
- Create New Document
- Config
Creating a central configuration (resource) location
The central configuration location can be any library in SharePoint. Some configuration files are located directly in this location and others need to be located in a sub folder of the specified location.
You can create the central configuration location and folder structure and upload configuration files to it manually or use MacroView Solution Provisioning to create a sample resource library with sample content by selecting Provision > New Library > MacroView Resource Library.
Configuring DMS to use the central configuration location
The Central Configuration Location (Resource Library) is set in the Store Folder Preferences section of the Support tab in MacroView Options:
The Central Configuration Location is specified in the Text field. Click the double dots on the right of the text field to browse your SharePoint environment and locate your desired central configuration location.
Once you've applied your settings in the MacroView Options menu, DMS will check that location once every 24 hours for any required configuration files, or configuration file updates, and will automatically download them to your user's machine.
In MacroView DMS version 8.9.798 and later the configuration data is automatically refreshed periodically or immediately when selecting a new central configuration location and closing the options window.
Deploying to your users
To deploy these setting to your users, copy the resulting entries in the following registry branch and push them to your users via Group Policy:
Computer\HKEY_CURRENT_USER\Software\MacroView\DMF\UserOptions\CentralConfigurationLocation
* - User settings folder refers to %appdata%/MacroView DMF/Store
* - From 8.8.519 File shares are no longer available to be selected as a location
Manually updating and refreshing resource files
DMS Client 8.8.520 and newer includes a "Refresh Configuration Data" button that will check and replace any files that do not exist or that have been updated in the central configuration location (resource library).
DMS will also check periodically if the resource files have been updated.
Setting the configuration refresh interval via the registry
The refresh check interval can be controlled by the 2 registry settings below located under \HKEY_CURRENT_USER\SOFTWARE\MacroView\DMF\UserOptions
ConfigurationDataMaxItemCount = 2000
This is an integer value that specifies the maximum number of items in the central resources library. If the library item count exceeds this number, no configuration data is downloaded and an error message is logged.
ConfigurationDataRefreshCronInterval = * * * * *
By default this is set to check daily: 0 0 * * *
The value for hourly: 0 * * * *
The value for every 15 minutes: */15 * * * *
This is a cron expression that specifies how often the periodic refresh mechanism is triggered. (see https://en.wikipedia.org/wiki/Cron for more information about cron)
In MacroView DMS Client version 8.9.798 and later changes made to most configuration files in the central configuration location are updated automatically without having to restarting DMS.
MacroView DMS Client version 8.9.1468 and later, when removing the path of the central configuration path, DMS will automatically remove the downloaded from %AppData%\MacroView DMF location.
For other
See Also
- To use the central configuration location, or set an alternate location, for deploying search panels see Managing client side search panels.
- To use the central configuration location to deploy Corporate Email Filing Rule, see step 3 in Getting Started with Corporate Email Filing Rules
- To set User options using a configuration file