Skip to main content
Version: 7.0

Configuration

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
Exampleen
if empty or undefinedLanguage of the computer. If not set as de, en or fr, packer is displayed in German.
ExplanationThe language in which packer is displayed. Currently there are three translations available (de = German, en = English, fr = French).
docuteamPacker.dataDir
ExampleC:/Data/RawData
if empty or undefined'Home' directory
ExplanationThis folder is displayed by default to select files or folders to be included in the SIP.
docuteamPacker.SIPDir
ExampleC:/Data/SIPs
if empty or undefined'Home' directory
ExplanationThis folder is displayed by default when a SIP is newly created, opened or saved.
docuteamPacker.backupDir
ExampleC:/Data/Backups
if empty or undefinedDirectory as defined in SIPDir.
ExplanationThe folder where the automatic backups are stored.
docuteamPacker.templateDir
ExampleC:/Data/Templates
if empty or undefinedDirectory as defined in SIPDir.
ExplanationThe folder in which the templates are stored.
docuteamPacker.exportsDir
ExampleC:/Data/Templates/exports
if empty or undefinedDirectory as defined in SIPDir.
ExplanationThe folder in which the export templates are stored.
docuteamPacker.reportsDir
ExampleC:/Data/Templates/reports
if empty or undefinedDirectory as defined in SIPDir.
ExplanationThe folder in which the report templates are stored.
docuteamPacker.reportsDestinationDir
ExampleC:/Data/Reports
if empty or undefined'Desktop'
ExplanationThe folder in which the created reports are saved by default.
docuteamPacker.tempDir
ExampleC:/Data/Temp
if empty or undefined'Temp' directory
ExplanationDer Ordner für temporäre Dateien.
docuteamPacker.lockFilesDir
ExampleC:/Data/LockFiles
if empty or undefinedThe folder of the current SIP.
ExplanationIndicates the folder where lock-files are stored (indicating openend SIPs).
docuteamPacker.AIPCreator.className
Examplech.docuteam.darc.ingest.AIPCreatorBasic
if empty or undefinedCreation of AIPs not possible.
ExplanationThe name of the class that creates the AIP.
AIPCreator.ingestSubmitDir
ExampleC:/Data/Submit
if empty or undefinedSubmission not possible.
ExplanationThe folder to which the SIPs are submitted.
docuteamPacker.newSIPDeleteSourceByDefault
Exampletrue
if empty or undefinedfalse
ExplanationIf true, the original files are deleted after the SIP is created.
docuteamPacker.newSIPDefaultsToZipped
Exampletrue
if empty or undefinedtrue
ExplanationIf 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
Exampletrue
if empty or undefinedtrue
ExplanationDuring 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
Exampletrue
if empty or undefinedtrue
ExplanationIf 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
Example20
if empty or undefined10
ExplanationMaximum number of backups created. If the number of backups exceeds this value, the oldest backups are deleted.
docuteamPacker.openFullScreen
Examplefalse
if empty or undefinedfalse
ExplanationIf 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.
docuteamPacker.screenSize.x, docuteamPacker.screenSize.y
Example1200
if empty or undefined1000x700 Pixel
ExplanationThe size of the SIP window in pixels. These values are ignored if openFullScreen = true.
docuteamPacker.screenPos.x, docuteamPacker.screenPos.y
Example500
if empty or undefinedZentriert
ExplanationThe position of the SIP window when it opens. These values are ignored if openFullScreen = true.
docuteamPacker.useSystemLookAndFeel
Examplefalse
if empty or undefinedfalse
ExplanationIf true, the appearance of packer is adapted to the computer's operating system. If false, a generic look ("Metal") is chosen.
docuteamPacker.defaultChecksumAlgorithm
ExampleMD5
if empty or undefinedSHA-512
ExplanationCryptographic hash function to calculate the checksum. Supported values are CRC-32, MD5, SHA-1, SHA-256 and SHA-512.
docuteamPacker.droid.signatureFile, docuteamPacker.droid.containerFile, docuteamPacker.droid.extensionUsage
Example./config/DROID_SignatureFile_V90.xml, ./config/container-signature-20170101.xml, 1
if empty or undefined./config/DROID_SignatureFile_V95.xml, ./config/container-signature-20180920.xml, 0
ExplanationIf DROID should not use standard configuration files, the values must be specified here.
docuteamPacker.SA.getSAsFromServerOnStartup
Examplefalse
if empty or undefinedfalse
ExplanationIf 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
Examplehttp://docuteam/sa
if empty or undefinedNo download
ExplanationThe web address from which the current Submission Agreements are downloaded manually or when packer is started (if so set).
docuteamPacker.OOConverter.path
ExampleC:/Programme
if empty or undefinedThe internal OOO application is used, if existing. If not, the preview of some files is not possible.
ExplanationThe folder in which the OpenOffice.org application is located, which is required for the preview of some files.
docuteamPacker.OOConverter.initializationRetries
Example30
if empty or undefined10
ExplanationThe number of attempts to initialize the OpenOffice.org application. This is required for the preview of some files.
docuteamPacker.pdftools.url
Exampletcp://10.0.0.123:7981/O2PService
if empty or undefinedtcp://localhost:7981/O2PService
ExplanationThe specifications for the 3-Heights Document Converter.
docuteamPacker.filePreviewer.cacheSizeLimit
Example20
if empty or undefined100
ExplanationThe size of the cache for the preview of the files. The higher this value, the more previews packer keeps in memory.
docuteamPacker.openSystemOutViewOnOutput
Exampletrue
if empty or undefinedtrue
ExplanationIf true, the error window is automatically opened when an error occurs. If false, the error window is not opened.
docuteamPacker.SIPView.TreeExpandAll
Exampletrue
if empty or undefinedtrue
ExplanationIf true, all elements of the SIP structure are displayed by default.
docuteamPacker.SIPView.DefaultTab
Example1
if empty or undefined1
ExplanationWhen 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
Examplealphabetical
if empty or undefinednone (i.e. order as defined in levels.xml)
ExplanationOrder of the list of available metadata fields.
docuteamPacker.DOIGenerator.nextNumberFilePath
Example./config/doi-numbers
if empty or undefined./config/NextNumber
ExplanationFile in which the last number used is stored.
docuteamPacker.DOIGenerator.prefix
Exampledoi-
if empty or undefinedDOI is generated without prefix, i.e. a sequential number.
ExplanationPrefix, which is set before the sequential number for the identifier.
docuteamPacker.CSV.mappings
Example./config/csv-sip-mapping_1.xml;./config/csv-sip-mapping_2.xml
if empty or undefineddefaults to ./config/csv-sip-mapping.xml
ExplanationPaths to CSV mappings that will be used to populate the default mappings in the "Create new package from a CSV file" dialog. Multiple values should be separated by ';'. Use relative paths based on the packer executable location.
docuteamPacker.actionsNotVisible
ExampledeleteItemDontAskAction, deleteItemAction, deleteFileContentAction, exploreAction
if empty or undefinedall actions are displayed
ExplanationList 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
ExamplePRE
if empty or undefinedNo prefix is set.
ExplanationThis 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
ExampleSUF
if empty or undefinedNo suffix is set.
ExplanationThis 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
Example40
if empty or undefinedNo adjustment is made.
ExplanationThe 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 undefinedThe validation scheme is necessary for the proper functioning of packer.
ExplanationValidation 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.