Configuration Parameters for Document Collections

Contents


1. Configuration Parameters
    1.1 General Directives
    1.2 Fields and their html-form description
    1.3 Notification settings
    1.4 CheckIn and Upload Directives
    1.5 Directives for Index Creation


1. Configuration Parameters

The following sections show the available configuration parameters to customise the behaviour of a document collection


1.1 General Directives

The settings of the "General Directives" determine the global behaviour of the collection.

Parameter NameDefault ValueExamples / Possible Values
General Directives
  CollectionStructure yyyy-nnn yyyy-ddd, yyyy-mm-dd, flat
  CollectionDisallowedNames 1) --- directories to be ignored for indexes, eg. cfg, ssi.
  CollectionNamePattern 1) --- regular expression name pattern, eg. [a-zA-Z]\w+
  CollectionDaySuffixPattern 2) --- regular expression pattern for day suffix, eg. [a-z]?
  CollectionAuthName --- Name of the authentication area of cookie mechanism



1.2 Fields and their html-form description

These configuration parameters determine the fields (i.e. document desciptors). It can be used to define the set of descriptors used for a document collection and their visual representation on the checkin HTML forms.

Parameter NameDefault ValueExamples / Possible Values
Fields and their html-form description
  Fields 3) --- Field1 Field2 ...
  Fieldname-Type text text textarea
  Fieldname-Size 30 applicable on for Type 'text'
  Fieldname-MaxLength 30 applicable on for Type 'text'
  Fieldname-Rows 5 applicable only for Type 'textarea'
  Fieldname-Cols 59 applicable only for Type 'textarea'
  Fieldname-Label Fieldname Main Label to appear near the field
  Fieldname-Label-Comment --- Additional description for field
  Fieldname-Default --- Default Value for new documents
  Fieldname-Logic --- person ('FieldnameXwho' variable in templates)



1.3 Notification settings

The email addresses and the templates used for the various notification messages.

Parameter NameDefault ValueExamples / Possible Values
Notification settings
  NotifyFrom --- From text for notification
  CheckInNotify --- notification to address(es) after checkin is done
  ModifyNotify --- notification to address(es) in case of document modifications
  DeleteNotify --- notification to address(es) in case of document deletion
  NotifyAtMetaDataCheckIn no yes/no notification also when meta data are submitted
  NotifyAtReceive no yes/no notification also when document(s) are received
  NotifyTemplate --- Mail template for notification
  CheckInNotifyTemplate --- precedence over 'NotifyTemplate'
  ModifyNotifyTemplate --- precedence over 'NotifyTemplate'
  DeleteNotifyTemplate --- precedence over 'NotifyTemplate'



1.4 CheckIn and Upload Directives

The templates and filesnames used for the automatically generated documents. Also the flow of actions of a check-in can be determined. Furthermore some of the check-in html forms can be modified via templates.

Parameter NameDefault ValueExamples / Possible Values
CheckIn and Upload Directives
  DummyDocumentTemplates --- list of files to be copied from config directory
  DummyDocumenttFilenames --- target filenames at document location
  MainFileReplacesDummyDocument yes yes/no mainfile replaces dummy document
  HtmlExternalUrlTemplate --- template for external documents
  UploadRequired no enforces upload of document
  SelectListLine $Title: $Author: the html-line for slecting documents
  MoreAuxiliaryFileLoop yes repeated offer to upload more auxiliary files
  MoreAuxiliaryFileLoop yes repeated offer to upload more auxiliary files
  ReceivingDocumentTitle --- Title for reception acknoledge page 'Document Received: CERN-IT-$RelDocId:'
  ReceivingDocumentEndTitle --- Customisable end message after document upload
  ReceivingDocumentEndInsert --- html insert after document upload
  MetaDataHtmlFormInsert --- html insert for meta-data form
  MetaDataCreateActionImage --- customisable image for meta-data-create-form
  MetaDataModifyActionImage --- customisable image for meta-data-modify-form
  UploadHtmlFormInsert --- html insert for upload form



1.5 Directives for Index Creation

The templates and filesnames used for the automatically generated indexes of the document collections.

Parameter NameDefault ValueExamples / Possible Values
Directives for Index Creation
  IndexStartYear 4) -- 2000
  IndexSortOrder ascending ascending, descending
  HtmlTopTemplate --- template for global index of collection
  HtmlTopFilename --- filename to be placed in collection root
  HtmlYearTemplate 4) --- template for index of year
  HtmlYearFilename 4) --- filename to be placed corresponding year
  HtmlMonthTemplate 5) --- template for index of month
  HtmlMonthFilename 5) --- filename to be placed corresponding month
  HtmlItemTemplate --- html template for each document
  HtmlNewMonthInsert: 5) --- html template for additional month insert



1) Directives apply only to CollectionStructure 'flat' !
2) Directives apply only to CollectionStructure 'yyyy-mm-dd' !
3) Several Fields exist and have predefined behaviour and html representation:
Title, Author, Abstract, Date, Access, Comment, YearMonthDay (compulsary for 'yyyy-mm-dd'), Name (compulsary for 'flat')
4 Directives apply only to CollectionStructures 'yyyy-nnn' and 'yyyy-mm-dd' !
5) Directives apply only to CollectionStructure 'yyyy-mm-dd' !