Skip to main content
Blackboard Help

Mass Configuration for Windows

This topic provides instructions and information for running the Blackboard Drive for Mass Configuration (Mass Config) utility. The Mass Config is used to configure end users' Blackboard Drive installations. For example, the Mass Config can create a new Volume for the end user and specify what drive letter this Volume should use. It can also be used to set various options such as the size of the cache.

Blackboard Drive Configuration Files

When it starts, Blackboard Drive loads its internal configuration files. It next looks for and, if necessary, loads an administrator-configured file. This file is downloaded from a URL specified by administrator.

View and download admin-config-sample.xml. to use as the template for your admin-config.xml file. Either create a copy of the file and name it admin-config.xml, or create a new file named admin-config.xml.

When using the Auto-Update feature, the xdconfig_customer.xml calls out to the server's update-info.xml file, which contains versioning information for the admin-config.xml file. If the version information has been updated, the admin-config.xml file will be called, and the new values will be brought to the user's system via auto-update. The configuration file for Mass Config is named admin-config.xml. See the table in Description of Configurable Attributes for parameter settings and syntax.

Preventing a User from Overriding the Value

For some parameters, you may need to prevent a user from overriding it. This is done on a per attribute basis by the presence of the gen:locks="edit" attribute in the configuration file.

For example, to set the server to https://as91sp6 and prevent the user from updating this value, the configuration file would include a definition like the following:

<server gen:locks="edit">

Description of Configurable Attributes

The following table provides the list of attributes that can be configured via the Mass Configuration utility, and provides details on the type of data and the possible and default values.

How to read the table:

  • The Name column lists how the item must be referenced in the configuration file.
  • The Description cell describes what the parameter is used for.
  • The Default value is the value that is used if none is specified.
Configurable Attributes
Name massUpdate
Description This version number must be present, and match the version number in the massUpdateCurrentVersion in update-info.xml.
This file and update-info.xml must always been synch with the version information.
Type string
Default value 0
Name userList
Description The template which creates all user settings is updated through
Default value <gen:updateListType>
Name userCacheDir
Description It is the path to the directory where user cache files are placed. For this path customization you can use macros as is described here: Usage of macros in config
Type expstring
Default value Depends on platform
Name proxyList
Description List of user proxies. By default the list contains only one main proxy only. Currently Blackboard Drive is able to operate with one proxy and does not give a user chance to maintain more of them. This is likely to change in future releases.
Default Value <gen:updateElement gen:templateguid="Xythos;15:03:08 14:14:46 +0100;MainProxy">
Name proxyUsage
Description Possible values:




To force proxy usage by a user, add attributes gen:locks="edit".

Type enum
Default Value DONT_USE_PROXY
Name proxyServer
Description The url of proxy server without port.
Type string
Default Value None
Name proxyPort
Description The port of proxy server. It has to be from the correct port range.
Type integer
Default Value 8080
Lock Level none
Name volumeList
Description List of all users' volumes.
Default Value  
Name updateListType
Description The template which creates all volumes is updated through gen:updateListType.
Default Value <gen:updateListType>
Name sharingLevel
Description The sharing level which should be used for this volume.

Possible values: None, Light, Medium, Heavy (or name of any new sharing level created by administrator).

Type string
Default value Heavy
Name username
Description Name of a user used to authenticate against remote server.
Type string
Default Value none
Name server
Description The url of server where the volume should be connected. Must be valid url.
Type string
Default value none
Name name
Description The name of the Volume.
Type string
Default value  none
Name bypassProxy
Description If true, the proxy will not be used for the connection of this volume with remote server (even if otherwise the proxy is used).
Type boolean
Default value  false
Name autoConnectAfterStart
Description Tells the Blackboard Drive if this volume should be automatically connected after start.

Possible values:

DISCONNECTED - default value, the volume stays disconnected

ONLINE - the volume will be connected

Type enum
Default value DISCONNECTED
Name openFileManagerUponConnection
Description If true, the default file manager window will be opened immediately after connection of the volume.
Type boolean
Default value false
Name lockTimeout
Description Time in seconds, after which the autolock on a file on the server expires. The value is sent to the server when locking a file. Note that WebDAV server may not respect this value and may use its own preferred value.
Type longnum
Default value 900
Name refreshPeriod
Description The time in seconds after which the autolock is refreshed if the document is still opened.
Type longnum
Default value 300
Name unblockFileAfterAppCloseTimeout
Description The time after which the file is considered to be really closed, measured since closure of the application used to edit the file.
Type longnum
Default value 3
Name normalUnlockDelay
Description The time after which the file is considered really closed. Measured from the close which makes the open count on the file equal zero. Applicable only for processes which are not listed in appsThatKeepFileClosed list. For example, after this timeout is file auto-unlocked.
Type longnum
Default value 5
Name appsThatKeepFileClosedWhileEditing
Description A list of names of processes, which does not keep file opened during editing. This list helps for example decide when to auto-unlock the opened file - such file can not be unlocked after last fs close, but we must wait for the whole application to be closed.

You can add processes which are known to behave as described. For example if you want to add application notepad++, because its known to does not keep file opened during editing, you can do it like this:

    <gen:newElement gen:guid="notepad+

Type List
Default value notepad.exe, wordpad.exe
Name neverLockList
Description A list of names of such processes, which will not autolock a file even if they open the file for writing.

You can add new processes. For example if you want to add the file manager servant salamander, you can do it like this:

    <gen:newElement gen:guid="salamand.exe" gen:val="salamand.exe"/>

Type List
Default value explorer.exe, totalcmd.exe
Name alwaysLockList
Description A list of names of processes, for which autolocking will be invoked even when the file is opened just for read.

You can add processes. For example if you want to add application notepad++, because its known to does not keep file opened during editing, you can do it like this:

    <gen:newElement gen:guid="notepad+

Type List
Default value notepad.exe, wordpad.exe, powerpnt.exe, ppcnvcom.exe
Name disabledApplications
Description List of applications for which the filter is disabled. If enabledApplications is defined then the filter will be used only with these apps. If disabledApplications is defined then the filter will be used for all applications excluding these

You can add processes:

     <gen:newElement gen:guid="notepad.exe" gen:val="notepad.exe"/>

Type list
Default value none
Name connectTimeout
Description Determines the timeout until a connection is established. A timeout value of zero is interpreted as an infinite timeout. If this parameter is not set, connect operations will not time out (infinite timeout).
Type integer
Default value 10
Name defaultMethodTimeout
Description Defines default socket timeout for methods (SO_TIMEOUT), which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets. A timeout value of zero is interpreted as an infinite timeout. If this parameter is not set, operations will not time out (infinite timeout).

This value will be applied to all methods except those which have their explicit values listed in MethodTimeoutsList.

In seconds.

Example of setting default method timeout to 100 seconds


Type integer
Default value  30
Name pruningMinimalTimeout
Description Minimal time after which pruning of XD cache is started after previous pruning.

In minutes.

Type string
Default value 15
Name cacheSize
Description The cache size in MB.
Type integer
Default value 512
Name clearCacheOnServerDisconnect
Description If set to true, the cache from a server is cleared after disconnection from the server.
Type boolean
Default value false
Name alwaysLocalFilesList
Description List of regular expressions. If a filename matches one of the expressions in this list, the file is considered local (is not uploaded).

You can add new regular expressionss:

    <gen:newElement gen:guid="mytmp" gen:val=".*\.mytmp"/>

Type list
Default value There are 2 default values: "(\.[^\.]*|\.\..+))" and "\.DS_Store"
Name notificationWindowPopupTime
Description This item defines lifetime of certain notification dialogs in seconds.
Type integer
Default value 30