Skip to main content
pdf?stylesheet=default
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">
  <gen:value>https://as91sp6</gen:value>
</server>

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.

List of configurable attributes

 
Name massUpdateCurrentVersion

Description

 

The value of this item is used by the auto-update feature to determine whether a new version of the configuration file needs to be retrieved from a mass-configuration server. When the massUpdateCurrentVersion in the config file on the remote mass-config server is higher that the massUpdateCurrentVersion in the local admin config, the remote config file is downloaded and applied. See Auto-update and Versioning for detailed description of how the mass-config system works.
Type string
Default value 0
Example <massUpdateCurrentVersion>
    <gen:value>10</gen:value>
</massUpdateCurrentVersion>
Lock Level None
Name userList

Description

 

The template which creates all user settings is updated through
gen:updateListType.
Type  
Default value None
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 %LOCAL_APPLICATION_DATA%\%SHORT_COMPANY_FOLDER%\%PRODUCT_FOLDER%\cache
Example Windows Vista & Windows 7 C:\Users\<username>\AppData\Local\<Short Company name>\<Short Product name>\cache\
Example Windows XP C:\Documents and Settings\<username>\Local Settings\Application Data\<Short Company name>\<Short Product name>\cache\
Lock Level None
Name userDataDir
Description The location which will be used for data storing during disaster recovery. The default location is user home. For this path customization you can use macros as is described in Usage of macros in config
Type expstring
Default Value %USER_HOME%
Example Windows Vista & Windows 7 C:\Users\<username>\
Example Windows XP C:\Documents and Settings\<username>\
Lock Level None
Name proxyList
Description List of user proxies. By default the list contains only one MainProxy 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.
Type  
Default Value <gen:updateElement gen:templateguid="Xythos;15:03:08 14:14:46 +0100;MainProxy">
Name MainProxy
Description

Currently Blackboard Drive is able to operate only with one proxy and does not give user chance to maintain more of them. The setting of this main proxy ("MainProxy") is created according to "proxySettings (template)" and contains following items:

proxyUsage
proxyServer
proxyPort
proxyUsername
proxyPassword
Guid Xythos;15:03:08 14:14:46 +0100;MainProxy
Type proxySettings (template)
Values
proxyUsage - "DONT_USE_PROXY", not locked
proxyServer - "", not locked
proxyPort - 8080, not locked
proxyUsername - "", not locked
proxyPassword - "", not locked
Name proxyUsage

Description

 

Possible values:

DONT_USE_PROXY(default)
USE_PROXY
AUTO_DETECT

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

Type enum
Default Value DONT_USE_PROXY
Lock Level None
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.
Type  
Default Value  
Name updateListType
Description The template which creates all volumes is updated through gen:updateListType.
Type  
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
Lock Level none
Name server
Description

The url of server where the volume should be connected. Must be valid url.

Type string
Default value none
Lock Level none
Name serverUrlCustomerConstraint
Description The server volume constraint where the volume should be connected. Represented as regular expression.
Type string
Default value none
Lock level 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
Lock Level none
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
Lock Level none
Name openFileManagerUponConnection
Description If true, the default file manager window will be opened immediatelly after volume connection.
Type boolean
Default value

false

Lock Level none
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
Lock Level Edition
Name refreshPeriod

Description

The time in seconds after which the autolock is refreshed if the document is still opened.
Type longnum
Default value 300
Lock Level none
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

Lock Level none
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
Lock Level none
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:

<appsThatKeepFileClosedWhileEditing>
    <gen:newElement gen:guid="notepad+

Type List
Default value notepad.exe, wordpad.exe
Lock Level none
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:

<neverLockList>
    <gen:newElement gen:guid="salamand.exe" gen:val="salamand.exe"/>
</neverLockList>
Type List
Default value

explorer.exe, totalcmd.exe

Lock Level none
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:

<alwaysLockList>
    <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
just with these apps. If disabledApplications is defined then the filter will be used for all applications excluding these.

You can add processess:

<disabledApplications>
     <gen:newElement gen:guid="notepad.exe" gen:val="notepad.exe"/>
</disabledApplications>
Type list
Default value none
Lock Level none
Name enabledApplications
Description

List of applications for which the filter is enabled. If enabledApplications is defined then the filter will be used
just with these apps. If disabledApplications is defined then the filter will be used for all applications excluding these

You can add processes :

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

Type List
Default Value none
Lock Level 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
...
<defaultMethodTimeout>
   <gen:value>100</gen:value>
</defaultMethodTimeout>
...
Type integer
Default value  30
Name pruningMinimalTimeout
Description Minimal time after which pruning of XD cache is started after previous prunning.
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:

<alwaysLocalFilesList>
    <gen:newElement gen:guid="mytmp" gen:val=".*\.mytmp"/>
</alwaysLocalFilesList>
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
Name helpPageURL
Description The url of a help page for Blackboard Drive.
Type string
Default value Depends on edition.
Name checkBeforeOpen
Description Tells the Drive if a file should be checked for any recent change before open (by means of PROPFIND method). If the drive finds out that the file was changed on server and the content of the file in cache is stale, new download is issued.
Type boolean
Default value false
Lock level none
Name cached Listings
Description If true and we have cached the content of the directory we do not do remote dirlist.
Type boolean
Default value false
Lock level none
Name refreshTimeout
Description Time since the last directory listing, after which is the cached directory listing or remote attributes considered out of date. Expiration of this timeout does not immediately trigger a request for directory listing from server - it only invalidates the cached listing, a new listing is retrieved only after any application requests it. It is treated as a preferred value, the Drive may not use this exact value.
Type integer
Default value 0
Lock level none
Name DisableRemoteAttributesAddition
Description Disables adding of new file or folder remote attributes (e.g. WebDAV properties) in properties dialog. Modification or deletion of existing attributes is unaffected.
Type boolean
Default value false
Lock level none
   
Name DisableRemoteAttributesModification
Description Disables modifying existing file or folder remote attributes (e.g. WebDav properties) values in properties dialog. Adding or deletion of attributes is unaffected.
Type boolean
Default value false
Lock level none
Name DisableRemoteAttributesDeletion
Description Disables deleting existing file or folder remote attributes (e.g. WebDAV properties) in properties dialog. Adding or modification of attributes is unaffected.
Type boolean
Default value false
Lock level none
Name logDirectory
Description It is the path to the directory where logs files are placed. For this path customization you can use macros as described in Usage of macros in config
Type Expstring
Example Windows Vista & 7 C:\Users\<username>\AppData\Local\logs\<Short Company name>\<Short Product name>\
Example Windows XP
C:\Documents and Settings\<username>\Local Settings\Application Data\logs\<Short Company name>\<Short Product name>\
Default value %TEMP%\logs\%SHORT_COMPANY_FOLDER%\%PRODUCT_FOLDER%\
Lock Level None
   
Name supressShellInfoTip
Description It supresses Windows Explorer's default behaviour when the user hovers the mouse over a folder. Infotip is not shown.
Type boolean
Default value true
Name cookiesPolicyURL
Description The value of this item is used as the URL to Privacy Center.
Type string
Default value edition dependent
   
Name massUpdateTimeout
Description The value of this item enables/disables displaying privacy information dialog containing cookies policy information at the startup. This dialog should be displayed on startup since new EU privacy law take effect in the EU on May 26, 2012 and it is related to the use of cookies. Users must receive detailed notice/info on cookies and their purpose.
Type integer
Default value 10
Name disableIntellittach
Description Enables or disable the Create Intellittach feature.
Type boolean
Default value false
Name disableVersioning
Description Enables or disable the Create Versioning feature.
Type boolean
Default value false
   
Name Intellittach type
Description

Defines the default Intellittach type. The default type is selected in the Create Intellittach dialog by default.
Possible values are:

LINK - create links by default
TICKET - create tickets by default.
Type string
Default value ticket
Name ShowIntellittachDialog
Description Disables or enables the Create Intellittach dialog. When set to false, the dialog is not displayed and the link or ticket is created according to default values.
Type boolean
Default value true
Name localConnectivityRecoveryTimeout

Description

 

The timeout determines the maximum period for which the HTTP request might be postponed in case  the local connectivity was lost. The local connectivity can be lost after resuming the computer from sleep mode or while switching between networks like Wi-Fi to Wi-Fi, Wi-Fi to Ethernet or Ethernet to Wi-Fi. Note that accidentally Java can cache negative DNS request for some period (by default 10 seconds: see the property sun.net.inetaddr.negative.ttl in java.security file) so this interval should be also taken into account.
Type integer
Default Value 30
Lock Level None
Since version

1.6 SP2

Name forceUnmountOnEndSession

Description

 

This parameter forces unmounting of the volumes that cannot be gracefully unmounted during system Log off, Restart or Shutdown. Note that it might cause the interruption of unfinished transfers, resulting in the data loss. The accompanying sign of this problem is never ending black screen appearance waiting for Blackboard Drive to exit, that results in a user’s necessity of choosing  Cancel or Force Log off/Shutdown/Restart button to leave the black screen. The parameter should be set to true only when customer experiences troubles with black screen on Windows Vista and later.

The Force Log off/Shutdown/Restart button causes Blackboard Drive is terminated immediately without chance to do proper actions needed during the exit of the application, in contrast to proper exit, with an exception of mounted volumes, when the forceUnmountOnEndSession is set to true. Note that sometimes an application can hold the opened file, which can cause the volume cannot be unmounted. That might be also good reason for setting this option to true, but administrator should remember that the amount of data loss depends on good or bad decision of the user. For example there might be a lot of files in the queue to save to the server from previous Drag&Drop action.

Type boolean
Default Value false
Lock Level None
Since version

1.6 SP2;  Note: this option has no effect on Mac OS X

Name DisableVersioningStateChange

Description

 

Defines if the options Enable Versioning and Disable Versioning on a file will be available to the user.
Type boolean
Default Value false
Lock Level None
Name DisableCheckoutStateChange

Description

 

Defines if the options Check Out, Check In and Undo Check Out on a file will be available to the user.
Type boolean
Default Value false
Lock Level None
Name DisableManualLockStateChange

Description

 

Defines if the options Lock and Unlock on a file will be available to a user.
Type boolean
Default Value false
Lock Level None