docuteam packer can be adjusted using several configuration files. The files are located at docuteam-packer/config.
docuteamPacker.properties
fileNameNormalizer.properties
charConversionMap.properties
If an adjustment has been made, a restart of docuteam packer is necessary for the changes to take effect. The file encoding should be ISO-8859-1.
docuteamPacker.properties
In the file docuteamPacker.properties basic adjustments can be made such as setting the language, view preferences, default folders or options for creating, delivering and saving SIP. All options as well as examples can be found as comments directly in the file.
The values true, false or en, de, fr are not case sensitive, i.e. true is identical to TRUE, True or even tRuE.
docuteamPacker.displayLanguage
Example
en
if empty or undefined
Language of the computer. If not set as de, en or fr, packer is displayed in German.
Explanation
The language in which packer is displayed. Currently there are three translations available (de = German, en = English, fr = French).
docuteamPacker.dataDir
Example
C:/Data/RawData
if empty or undefined
'Home' directory
Explanation
This folder is displayed by default to select files or folders to be included in the SIP.
docuteamPacker.SIPDir
Example
C:/Data/SIPs
if empty or undefined
'Home' directory
Explanation
This folder is displayed by default when a SIP is newly created, opened or saved.
docuteamPacker.backupDir
Example
C:/Data/Backups
if empty or undefined
Directory as defined in SIPDir.
Explanation
The folder where the automatic backups are stored.
docuteamPacker.templateDir
Example
C:/Data/Templates
if empty or undefined
Directory as defined in SIPDir.
Explanation
The folder in which the templates are stored.
docuteamPacker.exportsDir
Example
C:/Data/Templates/exports
if empty or undefined
Directory as defined in SIPDir.
Explanation
The folder in which the export templates are stored.
docuteamPacker.reportsDir
Example
C:/Data/Templates/reports
if empty or undefined
Directory as defined in SIPDir.
Explanation
The folder in which the report templates are stored.
docuteamPacker.reportsDestinationDir
Example
C:/Data/Reports
if empty or undefined
'Desktop'
Explanation
The folder in which the created reports are saved by default.
docuteamPacker.tempDir
Example
C:/Data/Temp
if empty or undefined
'Temp' directory
Explanation
Der Ordner für temporäre Dateien.
docuteamPacker.lockFilesDir
Example
C:/Data/LockFiles
if empty or undefined
The folder of the current SIP.
Explanation
Indicates the folder where lock-files are stored (indicating openend SIPs).
docuteamPacker.AIPCreator.className
Example
ch.docuteam.darc.ingest.AIPCreatorBasic
if empty or undefined
Creation of AIPs not possible.
Explanation
The name of the class that creates the AIP.
AIPCreator.ingestSubmitDir
Example
C:/Data/Submit
if empty or undefined
Submission not possible.
Explanation
The folder to which the SIPs are submitted.
docuteamPacker.newSIPDeleteSourceByDefault
Example
true
if empty or undefined
false
Explanation
If true, the original files are deleted after the SIP is created.
docuteamPacker.newSIPDefaultsToZipped
Example
true
if empty or undefined
true
Explanation
If true, the check mark "ZIP" is set by default when creating a new SIP. If false, the check mark is not set by default.
docuteamPacker.migrateFileKeepOriginal
Example
true
if empty or undefined
true
Explanation
During file migrations, the original file is replaced by the migrated version by default. If the option is set to true, both the source file and the migrated version are retained.
docuteamPacker.versioning
Example
true
if empty or undefined
true
Explanation
If true, the previous version will be saved as a backup in the folder backupDir during each save operation. If false, no backups are created and the original SIP will be overwritten each time.
docuteamPacker.versioning.keepBackupsCount
Example
20
if empty or undefined
10
Explanation
Maximum number of backups created. If the number of backups exceeds this value, the oldest backups are deleted.
docuteamPacker.openFullScreen
Example
false
if empty or undefined
false
Explanation
If true, the SIP editing window occupies the entire screen. If false, the two values screenSize.x and screenSize.y are used for the window size.
If DROID should not use standard configuration files, the values must be specified here.
docuteamPacker.SA.getSAsFromServerOnStartup
Example
false
if empty or undefined
false
Explanation
If true, the current list of Submission Agreements is downloaded from the web address entered in SA.BASE.URL when packer is started.
docuteamPacker.SA.BASE.URL
Example
http://docuteam/sa
if empty or undefined
No download
Explanation
The web address from which the current Submission Agreements are downloaded manually or when packer is started (if so set).
docuteamPacker.OOConverter.path
Example
C:/Programme
if empty or undefined
The internal OOO application is used, if existing. If not, the preview of some files is not possible.
Explanation
The folder in which the OpenOffice.org application is located, which is required for the preview of some files.
docuteamPacker.OOConverter.initializationRetries
Example
30
if empty or undefined
10
Explanation
The number of attempts to initialize the OpenOffice.org application. This is required for the preview of some files.
docuteamPacker.pdftools.url
Example
tcp://10.0.0.123:7981/O2PService
if empty or undefined
tcp://localhost:7981/O2PService
Explanation
The specifications for the 3-Heights Document Converter.
docuteamPacker.filePreviewer.cacheSizeLimit
Example
20
if empty or undefined
100
Explanation
The size of the cache for the preview of the files. The higher this value, the more previews packer keeps in memory.
docuteamPacker.openSystemOutViewOnOutput
Example
true
if empty or undefined
true
Explanation
If true, the error window is automatically opened when an error occurs. If false, the error window is not opened.
docuteamPacker.SIPView.TreeExpandAll
Example
true
if empty or undefined
true
Explanation
If true, all elements of the SIP structure are displayed by default.
docuteamPacker.SIPView.DefaultTab
Example
1
if empty or undefined
1
Explanation
When a value between 1 and 3 is entered, the corresponding tab is displayed by default in the detail view of a SIP. 1 corresponds to the object info, 2 to the description and 3 to the preview tab.
docuteamPacker.SIPView.metadataOrder
Example
alphabetical
if empty or undefined
none (i.e. order as defined in levels.xml)
Explanation
Order of the list of available metadata fields.
docuteamPacker.DOIGenerator.nextNumberFilePath
Example
./config/doi-numbers
if empty or undefined
./config/NextNumber
Explanation
File in which the last number used is stored.
docuteamPacker.DOIGenerator.prefix
Example
doi-
if empty or undefined
DOI is generated without prefix, i.e. a sequential number.
Explanation
Prefix, which is set before the sequential number for the identifier.
List of actions (separated by commas) that are not displayed on the packer user interface.
fileNameNormalizer.properties
In file fileNameNormalizer.properties you can specify the patterns according to which file names are cleaned up when the action "Clean up file/folder names" is triggered. This option can be found in the SIP detail view window under "Item" > "Clean file/folder names". The operation is performed for all files and folders in the SIP. It is also performed in the order specified in the file.
The following parameters can be set:
prefix
Example
PRE
if empty or undefined
No prefix is set.
Explanation
This value is prefixed to the file name at the time of standardization. For example, the file name "043.jpg" becomes "PRE043.jpg" if prefix=PRE. The prefix may also contain spaces.
suffix
Example
SUF
if empty or undefined
No suffix is set.
Explanation
This value is added after the file name (before the file extension) at the time of standardization. For example, the file name "043.jpg" becomes "043SUF.jpg" if sufix=SUF. The suffix may also contain spaces.
maxLength
Example
40
if empty or undefined
No adjustment is made.
Explanation
The character length of the file name (without file extension) is cut to the corresponding number of characters. This includes configured prefixes and suffixes.
fileNameRegex
Example
[a-zA-Z0-9.\\-\\/+=@_]*$
if empty or undefined
The validation scheme is necessary for the proper functioning of packer.
Explanation
Validation scheme (regular expression) to determine whether all letters present in the file name are allowed.
charConversionMap.properties
The file charConversionMap.properties contains a conversion table of special characters, which is used for the automated standardization of file names. The assignments correspond to key-value pairs.
The source character (e.g. ç) can be displayed in the configuration file either as such (ç) or in the form of its UTF-8 code (in Java context \u00E/).
Some examples:
# replace ü with ueü=ue# replace whitespace with _\u0020=_# replace ( with _# \ has to be escaped (cf. https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html)\\u0028=_
pdfToolsConverterWS.properties
The file pdfToolsConverterWS.properties defines parameters that are used by 3-Heights Document Converter (PDF Tools) if it is implemented as a web service.