Open Documentation Menu

System settings

Directory structure

Documents in the d.3 repository can be stored in different directories on the d.3 server. This chapter describes the differences.

Note

The directory names are to be viewed from the view of the d.3 server. This means the computer, on which the d.3 server processes (hostimp, d3async and d3server) are active.

If the directory C :\d3\d3.DOK\....... is displayed, then this is the drive C :\ on the d.3 server. Hence, the parameters are only useful, if d.3 admin was started on the d.3 server.

Directories
UUID-5f9a82b4-9af4-9e85-ce94-cb9f53e5e07d.png

Note

With the d.3 version 8.0 the directory structure was changed to minimize the file copy processes. So, a "lifelong" stable storage location is provided and no file operations will be executed by the status transfer. Every 100 document ID a new sub-directory is created. The file structure is: doc_id.file_id+abh. Extension The file_id is not 1:1 equivalent to each document version, that means, gaps between numbers in the file system can occur.

Basically and by default documents are located in the directory C:\d3\D3P.dok\docs.

Documents in cache are located in C:\d3\D3P.dok\cached_docs.

Shared files are located in the directory C:\d3\D3P.dok\share.

The Secondary Storage is located in C:\d3\D3P.dok\Jukebox.

Note

The directories can be changed by manual entry in the address field or by a click on the respective icon.

Old directories

The directories below were used in previous versions of d.3 (before 8.0).

UUID-93ebffc8-31a1-9807-9df7-5eec74c746b1.png
Processing

Every user and every group gets an individual processing directory.

For example: You store the file TEST.DOC into the processing of the user USER, then the document will be laid into the directory F:\d3\d3.dok\bearbeit\user of the file server as A0000001.DOC.

Assuming, by storage of the document it has got the document ID F0000001 and your d.3 directory structure is located in F:\d3\d3.dok.

(THIS ASSUMPTION WILL APPLY FOR FURTHER EXAMPLES).

The situation remains the same, if the document was archived into the processing of a group (e.g. F:\d3\d3.dok\bearbeit\group).

Verification

Once the previously stored document is transferred to the status "Verification" with d.3 smart explorer, then the document is moved into the respective directory.

Then, the document is located here: F:\d3\d3.dok\pruefung.

Approval

Once this document is verified and transferred into the status "Release", then the document is moved to the directory F:\D3\D3.DOK\PUBLIC\A000.

As you can see, the document is not directly moved to the PUBLIC directory but to the sub-directory A000.

This sub-directory structure is automatically generated by the d.3 system. The reason for the use of sub-directories is the increase performance. Under Microsoft Windows operating systems and Novell Netware, significant problems may occur, if one directory hold something like 500,000 files.

There is a further directory for this status under jukebox. This is used for the storage on the secondary storage.

Archive

After a further status transfer into the status "Archive", the document is stored in the directory F:\d3\d3.dok\archiv as A0000001.1. There is an additional directory for this status under jukebox. This is used for the storage on the secondary storage.

Sec. storage

This directory is required for the communication with the secondary storage system. It contains two sub-directories named Public and Archiv.

If a document in the status “Release” is to be written to the secondary storage, then this document is copied into the sub-directory Public. In our example, this would be F:\d3\d3X.dok\jukebox\public.

For the status "Archive" the directory would accordingly be F:\d3\d3X.dok\jukebox\archiv.

Requests for the retrieval of documents from secondary storage are directly written to the directory jukebox.

Notes

This directory contains the note files.

If you added a note to the document in our example, this would be stored in the directory F:\d3\d3.dok\notizen under the file name A0000001.NOT.

Workflow

This sub-directory holds the definitions for the rule-based workflows. It contains a sub-directory named Protokoll. In this directory, a workflow-log is stored for every document passing through a workflow.

OCR

This sub-directory contains the OCR files.

Data backup

You can save the actual master data by an automatically backup of the d.3 repository. The so created backup-files are stored in the d.3 document tree in the directory \D3P.dok\config\d3client\d3admin\mdbackup. With these files you can either reset the system to a previous state or build up an entirely new system.

The backup can be configured for a daily (at a certain time), weekly (always on monday) or monthly (on a certain day) interval. E-Mails can inform you about the backup job for each time or only on errors.

It is also possible to save the current state by an explicit export. The backup file is stored in the d.3 document tree, too.

Note

The backup file contains all data which are collected on recording the projects and milestones. Additionally the user data including all memberships in groups and assigning rights are saved. With this data you can reset the system to a previous state or build up an entire new system.

UUID-52a0717d-46d7-6433-c372-f816dee3b2a1.png

If the backup shall be executed automatically, do as follows:

  1. First, enable the option Automatic backup of all master and status data from the d.3 server.

  2. Specify, how often (daily, weekly, monthly) and at which time (start time) the backup shall be executed.

An automatically data backup as a snapshot is performed for every import-transaction of a transport file. This also creates a new milestone in the snapshot project and the current data will be stored there.

You have the opportunity to get informed about the backup by e-mail - always or only on errors.

  1. Enable the E-mail notification.

  2. Choose between Always notify or Notify on error.

  3. Enter your E-mail address in the respective field.

  4. Click on Apply.

Click on the button Export to export all master data and status data.

d.3 client config

The d.3 client config module is a plugin for d.3 admin, which is automatically configured with an installation of the d.3 applications (from version 5.5). Additional information can be found in the d.3 admin client config manual.

d.3 config

Every d.3 repository has five configuration files which are usually located under the d.3 server-directory (d3server.prg) in a sub-directory named like the short name of the d.3 repository (e.g. d3server.prg\\D3FU, whereby "FU" is the ID of the d.3 repository). This directory contains the files

  • d3admin.ini

  • d3fixed.ini

  • d3config.ini

  • d3addon.ini

  • aktplan.ini (obsolete)

With d.3 version 7 the dossier generation definition is administrated in the database. The aktplan.ini will be implemented by the update script once only.

The configuration files d3fixed.ini, d3config.ini and d3addon.ini are consecutively loaded on starting the d.3 processes (d3server, hostimp, d3async) in this order. In this process, the settings occurring in several configuration files are overwritten by the setting in the file read last (this is always the d3addon.ini last loaded from the d.3 server).

To customize the d.3 repository to your requirements, you can make changes to the configuration files. The file d3config.ini can be administrated in d.3 admin. Special settings can be applied in the d3addon.ini.

After the repository installation it always contains the path to the search template-files and the profiles configurable via the d.3 admin plugin d.3 client config.

Example: For the newly created repository "FU" the entry looks like this on Microsoft Windows:

CONFIG_PATH_D3CLIENT = „C\:\\d3\D3FU.dok\\config\\d3client“

For a Linux system, the following entry would be valid:

CONFIG_PATH_D3CLIENT = „/opt/d3/D3FU.dok/config/d3client“

Warning

Never change the file d3fixed.ini. This can lead to errors in your d.3 repository.

All changes must be applied in the files d3config.ini or d3addon.ini.

The d3fixed.ini contains all parameters used to configure the d.3 repository or used to create a repository with default settings. If you want to change any parameter you can find information about its usage in the file d3fixed.ini.

Note

Once you changed the d3addon.ini, you must restart the d.3 server processes in d.3 process manager for the changes to take effect.

Configuration dialog

The parameters listed and explained below can be easily read and modified with the d.3 config plugin of d.3 admin under System settings.

The parameters are combined to logical groups. For each parameter, a description, the default value and the currently set value are displayed.

UUID-821097e3-f8d5-bba3-7e75-f49fad1fe9be.png
  1. Initially, choose the logical group/section to which the parameter is assigned.

  2. Choose the parameter via its descriptive name (the technical name is usually not directly telling).

UUID-f4c51173-5b69-49cf-c06e-7e183c6be69b.png

Having enabled the respective parameter, you can choose an entry in the table to enter the change dialog of the parameter.

Sometimes, you can select a new value using a picklist or enter the new value manually or a file dialog is opened. If directory paths are expected, you can open a file open dialog.

UUID-0be7e870-dbe3-f108-5925-dc36529aa3bb.png

Note

The changes to values and parameter take effect after confirmation via OK/Apply or Save.

Configurable parameters

The following list contains the parameters which can be directly modified in the plugin d.3 config.

These are saved in the d3config.ini in the configuration directory of the repository under d3server.prg.

d.3 document server (document files)

Log every document access

LOG_EVERY_DOCUMENT_ACCESS

A log of every document access and the type of the access is created. This protocol can be used for invoicing purposes (accounting). The data is stored in a database table with the name zugriffs_protokoll.

As soon as this parameter is enabled, every visualization (or actually every action) of the document is written to the table zugriffs_protokoll. First, 100 accesses are cached and then written to the database in a batch to minimize the database load.

action

This column contains the action ID of the change.

Every changing action (import, property update, delete) has its own ID.

A list of the ID’s can be found further below.

tstamp_aktion

Date and time of last change

aktion_id

In this column all changes for every document are unique and ongoing numbered. The aktion_id is required for the link (join) with other tables, especially for the table firm_spez_mul_hist.

aktion_user

For each change in this column the d.3 user is saved, who executed the action.

aktion_text

This column contains a plain text for the change action. The user can enter a text for delete actions by himself.

Action ID:

action

aktion_text

INV001

ImportNewVersion

UPD001

Call of UpdateAttributes

DEL001

Text by user

The parameter only applies, if additionally the parameter LOG_CHANGES_IN_DB is enabled.

Default value: No

Values in the column art_zugriff:

1

View/Download

21

ImportNewVersion

22

UpdateAttributes

31

Deleted in dialog

32

Automatically deleted incl. document file

41

Linked

42

Link removed

51

Status transfer

52

Verified

53

Released

61

Delete a redlining

The table can be interpreted with the additional products Qlikview and d.link for Qlikview.

Column aktion_id:

In this column all changes for every document are unique and ongoing numbered.

The aktion_id is required for the link (join) with other tables, especially for the table firm_spez_mul_hist.

Backup of the attribute data in the database

SAVE_CHANGES_IN_DB

When

  • changing the property data of a document

  • or deleting a document or even

  • creating a link

or

  • removing a link

the old values are stored in the database.

Default value: Yes

Creating property backups when manually changing document-/dossier links

SAVE_USR_CHANGES_LINK_DOC

When manually creating or deleting a document-/dossier link, the changes are logged in the database (history table).

Default value: Yes

Creating property backups when automatically changing document attributes

SAVE_SRV_CHANGES_LINK_DOC

When automatically creating or deleting a document-/dossier, the changes are logged in the database (history table).

Default value: No

Creating property backups when manually changing document properties

SAVE_USR_CHANGES_ATTRIBUTES

When manually changing document properties, the old property values are logged in the database (history table).

Default value: Yes

Creating property backups when automatically changing document properties

SAVE_SRV_CHANGES_ATTRIBUTES

When automatically changing document properties, the old property values are logged in the database (history table).

Default value: No

Creating property backups when replacing the document files

SAVE_SRV_CHANGES_REPLACE_USEFILE

When replacing a document file of a document (e.g. by TIFF or PDF), the old property values are logged in the database (history table).

Default value: Yes

Creating property backups when importing a new document version

SAVE_USR_CHANGES_NEW_DOC_VERSION

When manually importing a new document version, the old property values are logged in the database (history table).

Default value: Yes

Creating property backups when importing a new document version by hostimp

SAVE_SRV_CHANGES_NEW_DOC_VERSION

When importing a new document version by d.3 hostimp, the old property values are logged in the database (history table).

Default value: No

Backup of job profile-based resubmission-entries

SAVE_DISTRIBUTION_BASED_HOLD_FILE_ENTRIES

Backup of non-job-profile-based resubmission-entries

SAVE_NON_DISTRIBUTION_BASES_HOLD_FILE_ENTRIES

Information on d.3 mailbox-entries which were sent via an activity profile are logged in the database (history table).

Default value: No

Log property data changes

LOG_CHANGES_IN_DB

Changes to the property data of a document, deleting a document or creating or removing a link are logged in the database.

Default value: No

d.3 database server (characteristics)

Database Management System

db_server

The following DBMS are available for selection:

ORAC

Oracle 7.3 or higher

MSQL

Microsoft SQL Server 6.5 or higher

INFO

Informix 9.3 or higher (is no longer supported with version 7.2)

DB 2

DB2 8.1 or higher

DB2-400

iSeries database

d.3 repositories

Database

List of database-names (ODBC-data source names; DSN) available in the login-dialog for the processes d3_server, d3_async, hostimp etc..

d.3 SMTP Support

Enable SMTP support

SMTP_SUPPORT

Apart from the internal d.3 mailbox functionality, d.3 can optionally send a SMTP-mail to the recipient. On activation of this parameter, the required drivers are loaded.

Default value: No

Enable SMTP for the resubmission

SMTP_MAIL_ON_HOLDFILE

When sending a resubmission for a document, the respective user is notified by mail.

Default value: No

Enable SMTP for the workflow resubmission

SMTP_MAIL_ON_WORKFLOW

When sending a resubmission for a document, the respective user is notified by mail.

Default value: No

Attach document reference to mail

SMTP_MAIL_INCLUDE_DOC

When d.3 sents an e-mail, it attaches a reference to the document. New d.3 smart explorer versions can open this d3l-reference file out of the d.3 repository.

Default value: Yes

SMTP gateway

SMTP_GATEWAY

The SMTP gateway forwarding the e-mail.

SMTP subject line

SMTP_SUBJECT

Subject line of the automatically generated e-mail message.

Default value: d.3 new message: subject_text

Send mail to own mailbox

SMTP_MAIL_ON_OWN_HOLDFILE

On activation an e-mail is also sent, if sender and recipient are equal.

Default value: No

Administrative SMTP-user

SMTP_ADM_MAILBOX_USER

This user account is used for the sending of the d.3 e-mails, when they are sent by system users such as d.3 async.

This parameter does not have a prefixed domain.

Administrative SMTP address

SMTP_ADM_MAILBOX_ADDRESS

E-mail address of the administrative SMTP-user. Some SMTP-servers do not allow sending anonymous e-mails. This could be the case, if d.3 system users send e-mails from within d.3. For these cases, you can specify an e-mail-address for the system users here.

SMTP_MAIL_WITH_URL_ON_HOLDFILE

When resubmitting a document, a link to the document viewer in d.velop documents is displayed in the e-mail.

SMTP_MAIL_WITH_URL_ON_WORKFLOW

In case of a workflow notification, a link to the document processing in d.velop documents is displayed in the e-mail.

d.3 retrieval behaviour

Warning

Note that changes to the retrieval behavior do not only affect the search for documents but also the functions used in document classes.

Before you change anything, please check, if you are using the mechanism to be changed in your document classes and adjust the document class restrictions if necessary.

Use none letters for the customization.

SQL wildcard substitute for %

WILDCARD_JOKER_1

The character '%', which stands for an unknown number of characters in a SQL query, is replaced by this character.

Default value: *

SQL wildcard substitute for _

WILDCARD_JOKER_2

The character ‘_', which stands for exactly one character in a SQL query, is replaced by this character.

Default value: ?

Delimiter for multiple search

SEPARATE_OR_SEARCH_CHAR

To search for multiple property values within one property field, you can define a key character using as delimiter here.

Example:

SEPARATE_OR_SEARCH_CHAR = "|"

Entry in the d.3 smart explorer: value1|value2

-> Search performed for "value1" or "value2"

Note

Disallowed characters are: Minus- and plus character, colon, slash and comma ('+', '-', ':', '/', ',').

Character for exclusive search

SEPARATE_NOT_SEARCH_CHAR

To exclude property values for a search in fields1 to 49 you can define a character here which precedes a value to be excluded.

Exclusive search via character SEPARATE_NOT_SEARCH_CHAR enabled for the following system property fields:

Owner (besitzer)

Document number (zeich_nr)

Editor (bearbeiter)

File name

File extension (datei_erw)

Comments (text)

Example:

SEPARATE_NOT_SEARCH_CHAR = “!"

Entry in d.3 smart explorer: !value3

-> Search everything except "value3"

Note

Disallowed characters are: Minus- and plus character, colon, slash and comma ('+', '-', ':', '/', ',').

Search character for empty property fields

SEPARATE_EMPTY_SEARCH_CHAR

To search for property fields without entry, you can configure a value here to represent the empty value.

Example:

SEPARATE_EMPTY_SEARCH_CHAR = '$'

Entry in d.3 smart explorer: $

-> Search for all properties without content

Search character for a range search in alphanumeric fields

SEPARATE_SPAN_SEARCH_CHAR

Defines a character to be used to search for a certain range in alphanumeric property fields (1-49, 60-69). This character can also be used for the definition of document classes.

Example:

SEPARATE_SPAN_SEARCH_CHAR = '~'

A search with "A~Z" finds all terms alphabetically following A and preceding Z, e.g. "Apple" or "Wolf".

A search with "Man~" finds all terms alphabetically equal to or following "Man", e.g. "Man", "Mouse" or "Wolf”.

A search with "~mouse" finds all terms alphabetically preceding or equal to "mouse", e.g. "Apple" or "Man".

Character for ‘less than' search in alphanumeric fields

SEPARATE_LESS_SEARCH_CHAR

Defines a key character that can be used for a less-than search in alphanumeric property fields (1-49, 60-69). This character can also be used for the definition of document classes.

Example:

SEPARATE_LESS_SEARCH_CHAR = '<'

A search with "<M" finds all terms alphabetically preceding "M", e.g. "Land" not "Mouse".

Character for ‘greater than’ search in alphanumeric fields

SEPARATE_GREATER_SEARCH_CHAR

Defines a character to be used to search for a greater than search in alphanumeric property fields (1-49, 60-69). This character can also be used for the definition of document classes.

Example:

SEPARATE_GREATER_SEARCH_CHAR = '>'

A search with ">Man" finds all terms alphabetically following "Man", e.g. "Mouse".

Key character for combinated search in multi-value property fields

SEPARATE_PAIR_SEARCH_60X_CHAR

To search for multiple multi-value property where several property values are located in the same row (combinated search), a character can be defined which can be used as key for the property fields to be combined by this search.

Example:

SEPARATE_PAIR_SEARCH_60X_CHAR = '§'

Entry in the d.3 smart explorer:

Feld60: §name1

Field61: §value1

Matches where the fields 60 and 61 contain the values "name1" and "value1" in the same row.

Key character for combined search in multi-value property fields

SEPARATE_AND_SEARCH_60X_CHAR

To search for multi-value property fields containing several identical property values, you can define a character to be used as a key character for the search.

Example:

SEPARATE_AND_SEARCH_60X_CHAR = "#"

Entry in d.3 smart explorer: Field60: name1#name2

Result: Matches containing "name1" as well as "name2" in the rows of field 60.

Search for the document status

SEARCH_STATUS_CURRENT

This parameter controls the search for the document status.

If the parameter is enabled (yes), all documents are returned whose current status is the specified one.

If the parameter is not enabled (no), then all documents are returned, having a version in the specified status.

Default value: Yes

Maximum number of multi-value property fields for one search

SEARCH_MAX_COUNT_60X_FIELD

Specifies the maximum number of multi-value property fields to be used in one search. A search across several multi-value property fields can result in performance issues so that you should avoid it whenever possible. This parameter only applies to the search in d.3 smart explorer.

Default value: 2

Search across several document types

DOC_TYPE_MULTI

Similar to the dummy-document type, you can define document types here for which the search across several document types is performed.

Example:

MUL1: Short name of a virtual document type

ART1, ART2, ... ,ART10: ordinary document types

DOKUART_MULTI[1] = "MUL1,ART1,ART7,ART9"

If you now perform a search via the document type "MUL1", then the document type "MUL1" as well as the document types "ART1", "ART7" and "ART9" are browsed.

Note

The first document type entered here is the dummy document type with the effect that this document type is not displayed in the import application. The parameter ENABLE_DUMMY_WRITE_ACCESS allows to control this behavior.

Short name of the dummy document type

DOCTYPE_SHORT_TEMPLATE

Specify the short name of a document type, which can be used as template for a cross-document type search.

Note

In new repositories, the server no longer returns dummy document types with write access. This has the effect that these document types are not displayed in d.3 import. The parameter ENABLE_DUMMY_WRITE_ACCESS allows to control this behavior.

Write access to dummy document types

ENABLE_DUMMY_WRITE_ACCESS

On enabling this parameter dummy document types is displayed in d.3 import if the user has write access.

Default value: Yes

Maximum documents to scan

SEARCH_FETCH_LIMIT

Here you specify the number of documents to be read maximum at an interactive search.

Background: While searching the rights validation/post-filtering starts. This means that it may be necessary

to examine more documents than to be delivered to the user.

Return of the 60 fields in the search as table

SHOW_60X_AS_TABLE

On enabling this parameter the values of different multi-value property fields are interpreted as a related table. The return always starts with the first line.

d.3 document storage

File extension of the note files

NOTE_FILE_EXT

File extension for the file name of note files.

Default value: NOT

Example: "NOT" => For a document with the document ID "IP004711" a created note file receives the file name "IP004711.NOT"

Increment the variant number on import

AUTO_VAR_NR_INCREMENT

If a document already exists for the specified document number and document type then, on import, the variant number can be automatically incremented to the next free number in order to assign a unique key. However, this only works, if no variant number is explicitly specified. Bookmark every newly stored document for later processing with other procedures. Example: all newly imported documents are to be exported again for distribution to other plants.

Default value: No

Automatic document number

AUTO_DOC_NR_ASSIGN_DIALOG

If no "zeich_nr" is specified on import then the document ID is automatically adopted as the "zeich_nr".

Default value: Yes

Additional server IDs

server_archive_ID_array

Up to 50 additional server IDs can be assigned to the document types.

Depending on these server IDs in the document ID the documents can be saved to different sections (pools) on the secondary storage medium.

Deleting documents from release or archive

ALLOW_DELETE_FROM_RELEASE

This allows the deletion of documents from the status release. Up to 5 additional server IDs can be assigned to the document types. Depending on these server IDs in the document ID the documents can be saved to different repositories on the secondary storage medium.

Default value: No

Warning

However, the following must be considered: First, the user who is to delete a document from status release in d.3 smart explorer must have the necessary rights. Furthermore, the document is not physically deleted, it is rather only tagged in the database that the document is no longer displayed in the result.

Property change for documents in release

ATTRIB_SUPPORT_MODIFY_RELEASE

If enabled, users with the respective right may change the properties of a document even if it is in the status release.

Default value: No

Reason for change on direct status transfer from processing to release

ALTERATION_TEXT_B_TO_F

If the parameter is enabled, user must specify a reason for the change when performing a status transfer from processing directly to release.

No plausibility check of properties on hostimport

NO_ATTRIBUTE_CHECK_ON_BATCH

For the batch import procedure hostimp, the validity of the properties is not checked for advanced property-definitions (datasets, regular expression, min-max-ranges) and with reference for the definition in the document type (mandatory field, etc.).

Default value: No

Validation of numeric property fields

VALIDATE_NUMERIC_FIELDS

When validating numeric fields with partially non-numeric content, the numeric part was retained and no syntax error was returned (Panther standard behavior). On activation of this parameter, this behavior can be changed. For new repositories this parameter is automatically enabled.

Default value: No

File extensions for dependent documents

view_dep_ext_default

This defines the file extensions, which are supported as dependent document.

In this case, the predefined extension have the following meaning:

or

Original

t1 t2 t3

TIFF

a1 a2

ASCII (text file)

n5

Lotus Notes file (e-mail)

p1

PDF

r1

Redlining

s1

Signature:

01

for change original - TIFF document

File extension for viewing dependent documents

view_dep_ext_type

Defines the exact file type of the supported dependent file extensions by d.3.

These can be used for determining the view application of the dependent documents.

Length of the document ID

DOC_ID_LENGTH

Length of the document ID in number of characters for new documents stored in d.3 .

Possible are 8 or 10 repositories, which have previously worked with 8-digit document ID’s can be changed to 10-digit document ID’s, if the database model with 10 character length is defined for the document ID.

With a 10-digit document ID and a 1-digit prefix for the repository/d.link 999,999,999 documents can be managed in d.3. (Default: 8)

Changing the file extension

SUPPORT_MODIFY_FILE_EXT

On activation it is possible to change the file extension during the lifetime of a document. For every document version, the file extension is stored separately so that each version can be opened with the original application.

Default value: No

Warning

The visualization of older document versions with modified file extensions only works with d.3 applications from d.3 version 6.3 or with applications supporting the API extensions of the v.6.3 server.

Note

The update of documents with another file-extension is since d.3 version 6.3 only possible by drag & drop to the d.3 document or via the hostimport.

An update using Save As .. creates a new import.

Truncating the property values

CUT_ATTR_VALUES_TO_DEF_LEN

If enabled, the property values are truncated to the length defined in the property repository on import and property update.

During the hostimport the behavior can be controlled with the parameter CUT_ATTR_VALUES_TO_DEF_LEN which is directly entered in the JPL file or in the default.ini individually.

Default value: No

Number of values per multi-value property field

CUR_60ER_FIELD_NR

This defines the number of values that can be interpreted per multi-value property field (60-field) for the import and the search. The default value is 100. The maximum allowed value for this parameter is 2000.

If the value of this parameter is reduced and documents exists with more multi-value property fields as specified here, then an error occurs on any change to the document and the action will be cancelled.

Warning

The parameter should only be increased, if you actually need to manage this number of values in multi-value property fields. A high value for this parameter negatively affects the performance during the import, property change and the search.

d.3 user interface and d.3 behavior

Format of date values in title-fields

CAPTION_DATE_FORMAT

For an alphanumeric collation in title-fields containing date-values, the format of the dates can be configured. The abbreviations are supported:

  • y for Year

  • m for Month

  • d for Day

CAPTION_DATE_FORMAT = 'yyyy-mm-dd' -> Datumswert = '2012-12-15'
d.3 gateway communication

d.3 internal server ID

d3fc_server_id

With this short name, the d.3 server process registers with d.3 gateway. This short name must therefore be a valid d.3 gateway repository ID (server ID). This short name is by default also the prefix of the file name (document ID) which d.3 assigns to the managed documents.

d.3 gateway host

d3fc_server_name

The d.3 server process must register with a d.link service. This requires the name or the IP address of the server hosting d.3 gateway.

d.3 asynchronous processing

Asynchronous processing of receipt-files from secondary storage

ASYNC_INTERPRET_OK_FILES

If this parameter is enabled, then the OK-files from the secondary storage are interpreted by the asynchronous d.3 process. If the parameter is not enabled, a separate process must interpret these files.

Default value: Yes

Directories for asynchronous jobs

ASYNC_JOB_DIR

Directories where the asynchronous jobs are stored.

Defaults for the job-processing

ASYNC_JOB_DEFAULT

Contains, equivalent to the default.ini the hostimport, default properties for the jobs.

Job type

ASYNC_JOB_TYPE

Type of the jobs:

MULTILINK: Multiple links

ATTRUPDA: Attribute data-update of existing documents

CUSTOMJOB: Customer-specific async-jobs

Extensions of the property files

ASYNC_JOB_FILE_EXT

File extensions to be used for the job files.

Extensions for the stored property files

ASYNC_JOB_SAVE_EXT

File extensions to be used for the backup of faulty job files. Faulty job files get a different extension so that the job processes do not interpret them again.

Directory for newly generated import jobs

IMPL_FOLDER_DIR

Directory where the asynchronous job processes store newly generated import jobs. The import processes create new folders etc. They are processed by the normal d.3 import (HOSTIMP) process. This directory must also be configured as one of the HOSTIMP import directories.

Extension for import jobs

IMPL_FOLDER_EXT

File extension for the newly generated import jobs.

Default value: fol

Folder for asynchronous import

ASYNC_IMPORT_DIR

Directory where the d.3 server process stores the data for the asynchronous import. These data are then taken over by the HOSTIMP. This directory must also be configured as a hostimport directory including the file extension.

Retention period of successfully processed jobs in the database

D3_JOBS_RUN_OK_LIFE_TIME_DAYS

Number of days that jobs remain in the database, if they have not been completed successfully.

Default value: 0

Retention period of successfully processed jobs in the database

D3_JOBS_RUN_ERROR_LIFE_TIME_DAYS

Number of days that jobs remain in the database, if they have not been completed successfully.

Default value: 31

Delete jobs per cycle

D3_JOBS_DELETE_PER_CALL

Number of old jobs to be deleted by d.3 async with every cycle.

Default value: 500

Recognition of folders

FOLDER_UNIQUE_KEY_NAME

These fields of the database are used for the dossier recognition by d.3 async. This mechanism is used only, if the dossier links are created via *.A0?-files (LIN001) and these files contain the parameter folder_definition set to "1". For dossier links using the aktplan.ini, this parameter has no effect.

Deletion (logic) of documents having exceeded the lifetime

DELETE_DOCS_ELAPSED_AUTO

On activation, the documents having exceeded the time to live are logically deleted if the "event-based deletion" was enabled for this document type.

Default value: No

Deletion of documents (physical) having exceeded the lifetime

DELETE_DOCS_ELAPSED_PHYSICAL

On activation, the documents having exceeded the time to live and which were logically deleted and which remained in the recycle bin for a specified number of days (RECYCLE_STORAGE_PERIOD) are also deleted physically.

Default value: No

Delete number of documents per cycle

DELETE_DOC_ELAPSED_PER_CALL

This defines the maximum number of documents to be deleted by the d.3 async in one cycle.

Default value: 50

Deleting documents from secondary storage

DELETE_DOC_ELAPSED_SEC_STORAGE

On activation, for documents having exceeded the time to live which are physically deleted, an according job is written for the d.ecs storage manager.

Default value: No

Retention time of deleted documents in the recycle bin

RECYCLE_STORAGE_PERIOD

This specifies the number of days for which documents remain in the recycle bin after the logical deletion before they are deleted physically.

Default value: 365

Deleting documents in the status processing

DELETE_FILES_FROM_PROCESSING

Specifies, if the document file is to be removed by deleting documents in the status processing. If the parameter is disabled, deleted verification versions can be recovered from the recycle bin.

Deleting documents in the status verification

DELETE_FILES_FROM_VERIFICATION

Specifies, if the document file is to be removed by deleting documents in the status verification. If the parameter is disabled, deleted verification versions can be recovered from the recycle bin.

Use specialized DEL100-async for automatically logical deletion

USE_DEL100_ASYNC

If you need to delete immediately a big amount of documents, this should execute a specialized DEL100-async. Additional information can be found in the manual d3batch_eng.pdf.

Automatical deletion of sent mailbox entries

CLEANUP_HOLDFILE_SENT

If this value is set to 0 (default), then sent mailbox entries will bot be removed automatically. Else, this value is for the amount of days after which sent mailbox entries will be deleted after acknowledging by the recipient.

Sec. storage

Addressing secondary storage media

jukebox_daemon

If a document in the d.3 status "Release" or "Archive" is not found on the document-server, then it can also be searched on the secondary storage medium.

Default value: No

Automatic storage on secondary storage

AUTO_DOCS_ON_SEC_STORAGE

Documents transferred to the d.3 states "Release" or "Archive" can optionally be reduplicated to the secondary storage immediately.

Default value: No

Release secondary storage directory

SEC_STORAGE_PUBLIC_DIR

Path to the directory from which the secondary storage retrieves the d.3 documents which are in the status “Release” and are pending for duplication on the secondary storage.

Example: O:\D3\D3.DOK\JUKEBOX\public

Free hard disk space on the secondary storage directory

STORAGE_DIR_MIN_FREE_SPACE

If the storage directory has less free space as this value specifies, then it will be written no longer to the secondary storage. As soon as more free space is available, the storage async will repeat the secondary storage. The free space will be determined every five minutes.

Synchronous storage

EXPORT_TO_STORAGE_SYNCHRON

During the import the files are copied synchronously to the secondary storage and also the outsourcing job is created synchronously. If you need higher performance you can disable this parameter. Then d.3 storage async does the storage asynchronously. d.3 storage async should be monitored to see that it complies with the work.

Secondary storage by d.3 async

ASYNC_CLEANUP_DISK

The d.3 async can free disk space if the secondary storage system is active and the space falls below the threshold defined in the parameter MIN_FREE_DISK_SPACE.

Default value: Yes

Lower threshold for free disk space

MIN_FREE_DISK_SPACE

Disk space in megabyte which must be at least available on the d.3 files server (document server). Once the disk space falls below this threshold, then some files are deleted from the file server which were already transferred to secondary storage successfully.

The d.3 async process continues this deletion until the configured number of documents to be deleted per cycle (DELETE_NR_DOCS_PER_CYCLE) is reached or until all documents were deleted for which a receipt entry for successful secondary storage exists.

Warning

In this process, even documents might be deleted where the retention time in the cache was not yet exceeded.

Additionally the parameter DISK_CACHE_CLEANUP_DEP_DOCS can influence the cache clean up.

Default value: 500

Delete documents from cache per cycle

DELETE_NR_DOC_PER_CYCLE

Specifies the maximum number of documents to be deleted from the cache per cycle of the d.3 async.

Warning

If this chosen number is to big, the deletion process can block the asynchronous process of d.3 for a longer time.

Default value: 1000

Deleting dependent documents from cache

DISK_CACHE_CLEANUP_DEP_DOCS

On activation dependent documents are also deleted from the cache.

Default value: Yes

Save document properties

ATTR_TO_XML

All document properties are saved in the d.3 database. If this parameter is enabled, then document properties from status release are stored additionally in the XML files.

These will be stored on enabled jukebox secondary storage to the secondary storage. The secondary storage directory must exist and configured via parameter D3_VERZ_DOK_ATTRIBUTE.

Size for the document property file

ATTR_FILE_MAX_KB

If the parameter ATTR_TO_XML is enabled, then this is the maximum size for the file containing the document properties to be written to the secondary storage. Such a file can contain the full-text information of multiple documents.

Note

The size of the XML-file can also be modified repeatedly during runtime. The size is checked after a new property set was attached to the XML file and is then decided, if the file is closed and transferred to the secondary storage. The recommended size is the default of 50 KB.

Default value: 50

Directory for document property files

ATTR_FILE_DIR

Directory where the files with the document properties are to be written. From this place they are retrieved and written to the secondary storage.

Retroactive storage

ASYNC_STORAGE_EXPORT

If this parameter is enabled, then d.3 async will retroactively store documents on the secondary storage which were not yet stored based on the current configuration but have to be stored. Functionality is only executed, if AUTO_DOCS_ON_SEC_STORAGE is enabled.

Default value: Yes

Time for the determining of documents pending for secondary storage

ASYNC_STORAGE_EXPORT_TIME

Since determining the documents pending for secondary storage can take some time in large systems, this is only performed once per day and the required information is stored in a separate database table. Here, you can change the time when this should approximately be done (format: “hh:mm”).

Default value: 21:00

Import-procedure HOSTIMP

File extension for action-files

HOSTIMP_ACTION_FILE_EXT

If a hostimport directory is filled with files with various file extensions, then a new hostimport entry (as400_import_*) must be created for every file extension.

Create (as400_import_*).

Using a so called "action-file", an indirect file-import can be created and must only one entry per directory is required. For this effect, an action-file must be created together with the other files for the hostimport. This action file then contains the variable import_file_ext with the file extension of the actual document files. The file extension of the action-file is configured in this parameter and must be entered as a file extension for the hostimport in the variable as400_import_datei_erw.

Default value: action

Note

Action files are created by the newer versions of d.link for lotus notes or d.link for microsoft exchange..

Example for an assignment in an action-file:

import_file_ext = „doc"

Max number of documents per cycle

HOSTIMP_MAX_NR_DOCS_PER_SESSION

Maximum number of documents which are to be stored in d.3, with every login of the d.3 hostimp. On reaching this number, the d.3 hostimp closes automatically. It can be restarted automatically using the program d.3 process manager.

Default value: 20000

Import directories

HOSTIMP_IMPORT_DIR

Directories containing the documents to be imported.

Example: O:\D3\HOSTIMP

Default values for the properties

HOSTIMP_IMPORT_DEFAULT

Control file specifying the properties equally applying to all documents to be stored from the respective directory (e.g. ....\DEFAULT.INI). These properties will be specified by the document specific properties written in the JPL file. These can be overwritten by the document specific JPL file.

Example: O:\D3\HOSTIMP\DEFAULT.INI

The file extension for the import

HOSTIMP_IMPORT_FILE_EXT

File extension defining the documents to be imported (e.g. TIF, TXT).

Dependent documents for hostimport

HOSTIMP_INCL_DEP_DOCS

Yes: The hostimport browses the import directory for dependent documents with all extensions configured in d.3 as dependent documents (see view_dep_ext_default).

No: No dependent documents are imported.

Default value: Yes

Minimum free space on the hard disk

HOSTIMP_MIN_DISKSPACE

The specified number of megabytes must at least be available on the hard disk for the d.3 hostimport processes to operate. Else, the processes stop again.

Default value: 10

JPL file required

HOSTIMP_JPL_MANDATORY

On activation the hostimport expects an property file with the property data for the document in addition to the document file itself.

Default value: Yes

Import directory for restriction sets

D3SET_IMPORT_PATH

Directory containing the files used to create or change the restriction set-assignments.

For a restriction set-assignment, a JPL-file and a TXT-file must be located in the directory.

The JPL file can contain two parameters:

“set_name” represents the name of the restriction set and is a mandatory parameter.

“set_object” specifies, to which object the set filter is to be assigned. You can specify user names, group name, job profiles and organizational units.

The TXT-file contains the set-filters whereby the filters are delimited with a ;-character or a line-break.

Example for .jpl file:

set_name = "Suppliers from A to M"

set_object = "Purchasing"

Ignore additional multi-value property fields

HOSTIMP_IGNORE_ADD_6X_VALUES

Allows to import documents with more than one CUR_60ER_FIELD_NR property values. Here, the additional properties are ignored (Attention: data may get lost).

Default value: No

API logging parameter

Warning

Log level 9 may only be enabled temporarily, as the debugging mode strongly reduces the server performance.

d.3 async log

D3_ASYNC_LOG_LEVEL

0 = only critical errors

6 = only information

7 = every job being edited is displayed in the log viewer

9 = everything (debuglevel)

d.3 storage async log level

0: Only critical errors

6: Only information

7: Every job being edited is displayed in the log viewer

9: Everything (debug level)

Attention: Log level 9 may only be enabled temporarily, as the debugging mode strongly reduces the server performance.

d.3 server log level

D3_SERVER_LOG_LEVEL

You can define the range of logging information traced for the individual calls to the d.3 system here:

0 = only critical errors

3 = API-call entry and exit

6 = same as 3, but additional import parameter

7, 8 = same as 6, but additional SQL-commands for search

9 = everything (debuglevel)

Default value: 6

d.3 API timeout

D3_API_SELECT_TIMEOUT

A search query is aborted having exceeded this time, if the d.3 server process can communicate the cancellation to the SQL-server.

Default value: 60

d.3 hostimp log level

D3_HOSTIMP_LOG_LEVEL

6 = only information (default)

7 = Short information on each imported file

9 = everything (debuglevel)

Default value: 6

Maximum length for log-rows

MAX_LOG_LINE_LENGTH

This value defines the character length of the log entries.

Default value: 70

SQL-Runtime-Logging lower limit

MIN_SQL_LOG_RUNTIME_MILLIS

All ODBC-operations taking longer than the specified number of an milli-seconds, are logged with the default log level (6) and not with debug level (9).

Crash protocol files (mini-dumps)

MINIDUMP_WITH_FULL_MEMORY

This parameter specifies, if and how the crash protocol files are to be written in case of an error.

Hook functions

Groovy-Hook-directories for customer-specific program adjustments

HOOK_GROOVY_DIRS_CUSTOMER

Specify the directories here, which contain the customer-specific program adjustments implemented by Groovy.

JPL file for customer-specific program adjustments

HOOK_JPL_FILES_CUSTOMER

Name of the .JPL files containing the custom program adjustments (hook functions).

Execute hook functions

HOOK_FUNCTIONS_MAPPING

Entering the JPL hook functions to be executed at the respective entry point (HOOK_FUNCTIONS_ACTIVATE).

Groovy functions do not have to be entered here!

On process start, all Groovy files in the configured Groovy hook directories are parsed and the found hook functions are registered automatically. The result of the parsing is returned to the d.3 log and written into a file log\groovy_hook_functions_registered.txt.

Activate reload of Groovy-hook-files on change

HOOK_GROOVY_RELOAD_ON_CHANGE

If this parameter is enabled, then saving changes in Groovy-hook-files has the effect that they reloaded immediately. As a result, no d.3 process has to be restarted and the code changes take immediate effect. This parameter can facilitate the developmemnt of a hook function. However, it should remain disabled in a productive environment.

User name for d3fc from hooks

HOOK_DEFAULT_D3FC_USER

Default user for d3fc-calls from hooks.

Password for d3fc from hooks

HOOK_DEFAULT_D3FC_PASSWORD

Default password for d3fc-calls from hooks.

Password identifier for additional DB connections

HOOK_PASSWORD_NAMES

These identifiers can be used as placeholders for passwords in JPL hooks.

The usage is described in "d.3 hook api (jpl)".

Passwords for additional DB connections

HOOK_PASSWORDS

Passwords for replacing the placeholders in JPL hooks.

Parallel use of JPL and Groovy

HOOK_ENTRY_POINT_JPL_AND_GROOVY

If this option is enabled, then you can register JPL hook function and Groovy hook methods for the same hook entry point.

If you have specified the name of a JPL hook function in the "Hook Function" column under "Execute Hook Functions" and an annotation for this entry point exists in a Groovy hook module at the same time, both are registered for this entry point.

[de] eine Annotation für diesen Einsprungspunkt in einem Groovy-Hook-Modul, so werden beide für diesen Einsprungspunkt registriert.

When executed, the JPL hook function is called first, followed immediately by the annotated Groovy hook method(s).

Import

Field number for barcode-status

BARCODE_STATUS_FIELD_NR

Number of the database field holding the status of the barcode.

0: booked

1: scanned

Default value: 88

Remove whitespaces on import

REMOVE_BLANKS_IMPORT

Remove leading spaces in property data on import.

Default value: No

Hash-value creation for single instance check / check for duplicates

GENERATE_DUP_HASH

On activation, hash-values are generated and entered in the database for newly created or modified documents to check for duplicates. Older documents which existed in the repository before the activation of the parameter can be provided with a hash-value by executing the JPL script fill_empty_hash_values.jpl.

Default value: No

Check for duplicates

TEST_FOR_DUPLICATES

On activation it is already checked when importing a document, if a document with the same hash-value already exists in the database.

Default value: No

Note

If such a document already exists, the import is rejected. In case of a rejection by the hostimport, the document files are moved to the sub-directory duplicates and additionally a file with the extension .dup is created containing information on the refenece-document. When importing via ImportDocument or ImportNewVersionDocument the error "10036" is triggered in case of a rejection. Information on the reference-document can then be found in the export-parameter doc_id.

Ignore duplicates in processing and verification

IGNORE_DUPS_IN_B_P

This parameter controls, if the single instance check considers the processing- and verification versions of documents are to be considered because these versions are not audit-proof and can so be deleted at any time. By default these versions are ignored during the check.

Default value: Yes

Reading documents in the status “Archive”

IGNORE_DUPS_IN_A

This parameter controls, if the single instance check considers the archive-versions of documents. By default these versions are ignored during the check.

Default value: No

Ignore duplicates in other document types

IGNORE_DUPS_IN_OTHER_DOCTYPES

This parameter controls, if the single instance check considers the archive-versions of documents. By default these versions are considered during the check. By default documents from other document types are considered during the check.

Default value: No

Workflow

Enabling the workflow 

WORKFLOW_SUPPORT 

d.3 supports business processes with workflows.

Default value: No

Directory for the storage of the workflow-definitions 

WORKFLOW_DEF_DIR 

Path for the storage of the workflow-definition in XML-format.

workflow-module-library - server 

d3fc_wfl_library_server_name 

Hostname of the d.3 server where the workflow-module-library is stored.

Note

This value must be configured, if the workflow for this repository is enabled but the workflow-module-library is located in another repository.

workflow-module-library - repository ID 

d3fc_wfl_library_server_id 

Repository ID of the d.3 repository where the workflow-module-library is stored.

Note

This value must be configured, if the workflow for this repository is enabled but the workflow-module-library is located in another repository.

workflow-module-library - TCP/IP port 

d3fc_wfl_library_tcpip_port 

TCP/IP port of the d.3 repository where the workflow-module-library is stored.

Note

This value must be configured, if the workflow for this repository is enabled but the workflow-module-library is located in another repository.

Rendition of the workflow-protocol 

WORKFLOW_LOG_TIFF 

The workflow-protocols are rendered on completion of the workflow and are attached as dependent TIF w1 to the document.

Default value: No

Stylesheet for workflow-protocol 

WORKFLOW_LOG_STYLESHEET 

XSLT-stylesheet used to transform the workflow-protocol and thus defines the layout of the rendered protocol. It must deliver an HTML file.

Default value: default.xsl 

Write workflow-protocols to secondary storage 

WORKFLOW_WRITE_LOG_TO_SEC_STORAGE 

On activation, the workflow-protocols are written to the secondary storage disregarding the parameter SCHREIBE_ABH_DOKS_AUF_JUKEBOX (in the d3fixed.ini).

Default value: Yes

Manual workflow-start for documents 

WORKFLOW_START_MANUALLY 

On activation: A document can always be manually (e.g. via the d.3 smart explorer) placed in any workflow.

On deactivation: Only documents configured for the manual workflow-start type, can be manually (e.g. via the d.3 smart explorer) placed in this workflow.

Default value: No

Backup of the workflow protocol entries in the database 

WORKFLOW_SAVE_STEP_PROTOCOL_DB 

If this option is enabled, the protocol entries of all successfully completed workflows are stored in the database (history table).

Default value: Yes

Backup of the workflow variables in the database 

WORKFLOW_SAVE_USER_VALUES_DB 

If this option is enabled, the used workflow variables of all successfully completed workflows are stored in the database (history table).

Default value: Yes

Statistics

Enabling the statistics

STATISTICS_SUPPORT

If this parameter is set to "Yes" and the SQL-statistics table (statistics_archiv and statistics_run) exist, then d.3 logs statistics for every different file-extension (.TIF, .TXT, ...) and for all document classes regarding the load (number of document IDs, number of physical files, sum total KB). Dependent files were ignored here.

If you want to obtain statistics using the documents and document classes, then enable this parameter. To do so, set the parameter to "1". Afterwards, execute the script statistik_d3_belegung.jpl.

Warning

To do so,first stop the d.3 processes (d3_server, HOSTIMP, d3_async), as well as all other processes which are accessing the database.

Furthermore, you should create a backup of the database.

Start the shortcut Start | Programs > d.velop > d.3 > d.3 server interface (repository name) with the dialog for the execution of external JPL scripts. The password of the master user must be entered manually in the login-mask. Then start the external JPL program statistik_d3_belegung.jpl via Programs > External programs which is located in the sub-directory d3server.prg\ext_jpl.

This script browses the entire d.3 repository and initializes the statistics table with the current values. This program must be run once before you can work with the statistics.

Warning

In large repositories, running the script may take several minutes or longer (up to one hour and more) - depending on the number of stored documents). Please do not abort the script as your d.3 system might otherwise show erroneous behavior.

Default value: No

Statistics interval

STATISTICS_INTERVAL

The statistics for the d.3 repository utilization is in the SQL-tables in certain intervals to facilitate reporting for certain time-ranges later. Allowed values for BELEGUNG_STATISTIK_INTERVALL are:

W. weekly

M: monthly

Default value: M

Password

Minimum password length

PASSWORD_MIN_CHARS

Minimum length of the password a user can have.

Default value: 8

Extended syntax rules for passwords

PASSWORD_EXTENDED_SYNTAX

This parameter controls if the passwords must comply with certain rules.

The following syntax-rules apply on activation:

  • At least one character from at least two of the following three groups: A-Z, a-z, 0-9.

  • At least one special character.

  • The password must not contain the user name.

Default value: Yes

Note

This password setting only affects changes via the Login-Manager.

Time to live of a password

PASSWORD_EXPIRE_DAYS

Time to live of a password in days.

Default value: 10957 (= 30 years)

Enabling the password history

PASSWORD_HISTORY_ENTRIES

If a value > 0 is specified, then the password history is enabled and recent passwords are stored. The parameter value specifies the number.

Default value: 10

Note

A new password must then differ from those in the history.

Count failed logins

PASSWORD_USER_FAILCHECK

This parameter logs the failed attempts of users to logon. Afterwards, a user is blocked after a specified number of failed login attempts (parameter: PASSWORD_INPUT_TRIALS) and optionally unblocked after a certain time automatically (parameter: PASSWORT_USER_REJECTED).

Default value: No

Failed login threshold

PASSWORD_INPUT_TRIALS

Number of attempts after which a user is blocked if his password was incorrect. This parameter only applies, if PASSWORD_USER_FAILCHECK was enabled.

Default value: 3

Unlock automatically

PASSWORD_USER_REJECTED

Time in minutes after which a blocked user is automatically unlocked. If the parameter is set to "0", then d.3 administrator must unlock the user.

Default value: 60

Change password after unlocking by administrator

PASSWORD_ALTER_ADMINRESET

If this parameter is enabled, then a user must change his password after is was reset by the administrator with the next logon. The parameter does not apply, if LDAP is used. d.3 can only read an LDAP structure such as AD.

Default value: No

Note

d.3 user passwords can have a maximum of 20 Bytes. This restriction results from the d3fc protocol, where the 20 Bytes are to be set in the header.

For each d.3 API-call user name + password will be transmitted. The password must fit into the call-header.

Longer user passwords can only be supported actually by using session passwords as done by the LDAP-interface with Kerberos authentication.

The usable number of characters can be smaller in unicode mode depending on which (special) characters are used in the password because ASCII characters are coded with multiple bytes.

Bidirectional proxy

Support for the bidirectional d.3 proxy

PROXY_BIDIRECT_SUPPORT

Support for the bidirectional d.3 proxy (with enabled write cache)

Warning

This parameter must not be simply disabled!

If the bidirectional proxy functionality is used and is disabled, then you must first disable the write cache of all d.3 proxy systems accessing this repository.

Only afterwards, this parameter may be disabled here on the d.3 server. Else, proxy placeholders are still stored but the actual documents are no longer automatically synchronized from the proxy systems to the repository.

Having enabled it, all d.3 server processes must be restarted!

Default value: No

Start time for synchronization

proxy_sync_start_time

Time interval in which the d.3 async process automatically synchronizes the data from the write-cache. If access is required outside this interval, the d.3 gateway fetches the document from the write cache "on demand".

Default value: 18:00

Stop time for synchronization

proxy_sync_stop_time

Time interval in which the d.3 async process automatically synchronizes the data from the write-cache. If access is required outside this interval, the d.3 gateway fetches the document from the write cache "on demand".

Default value: 23:59

Timeout for synchronization

proxy_sync_timeout

Maximum number in seconds that d.3 waits for a document not yet synchronized from the write cache before it sends an "on demand" synch request to d.3 gateway.

Default value: 30

d.ecs rendition service

Support for d.ecs rendition service 

DTIFF_SUPPORT 

Enabling the optional module d.ecs rendition service (server-based rendition) for d.3.

Note

The name TIFF in the parameters general substitutes for the rendition of documents and thus refers to the creation of TIFF or PDF documents (PDF only with installed PDF extension).

Default value: No

d.ecs rendition service server 

d3fc_dtiff_server_name 

Name of the machine where d.ecs rendition service (optional module) is installed. The host name of d.3 gateway must be specified in DTIFF_LEVEL = 1.

Via d.ecs rendition service you have the option for the server-based rendition of documents.

Default value: localhost

TCP/IP port for d.ecs rendition service 

d3fc_dtiff_server_tcpip_port 

TCP/IP port of the machine where d.ecs rendition service is installed. The host name of d.3 gateway must be specified in DTIFF_LEVEL = 1.

Timeout for d.ecs rendition service 

d3fc_dtiff_server_timeout 

Default value: 3404

Maximum time in seconds for which d.3 waits for the (TIFF-)result once it sends the request to the d.ecs rendition service for synchronous processing. This timeout prevents blocked d.3-processes in case of exceptionally long renditions.

After this timeout, rendition-jobs are checked asynchronously by the d.3 async process and the TIFF-document is transferred to d.3.

Default value: 30

Full-text-search (d.3 search)

Support for d.3 search

DSEARCH_SUPPORT

Enabling the use of the optional module d.3 search (external full-text engines) for d.3. For the import, the parameter KEYWORD_OPTION must at least be set to "1".

Warning

The full-text support with a unicode d.3 repository is only granted with d.3 search.

Default value: No

Full-text-option

KEYWORD_OPTION

The following options are available for the full-text management:

0: No words are adopted in the full-text index on import.

1: Only the document properties are transmitted into the full-text index.

2: The document properties as well as the document content (OCR file) are transmitted into the full-text index.

3: The document properties as well as the content of the document file are transmitted into the full-text index.

4: The document properties, the document content as well as the content of the document file are transmitted into the full-text index.

Note

Prerequisites for the full-text management and full-text search is an installation of the product d.3 search!

For using d.3 search the parameter DSEARCH_SUPPORT (see "Support for d.3 search”) must be enabled explicitly.

OCR extension

ocr_ext

Extension identifying the d.3 keyword-file.

During the batch-import, a full-text indexing is only executed, if a file with the specified ending exists and the configuration parameter KEYWORD_OPTION is set to "2".

The keyword-file should be a pure text-file without special characters. Documents created with word processing-applications such as DOC-files with Microsoft Word are not supported. They must first be converted, i.e. the formatting information must be removed.

d.3 search server

d3fc_dsearch_server_name

Name of the host where d.3 search (optional module) is installed. Using d.3 search external full-text-engines can be integrated.

Default value: localhost

From d.3 search 3.0 on, a d.3 gateway connection is also supported. As name, the server on which d.3 gateway is running must be specified.

TCP/IP port for d.3 search

d3fc_dsearch_server_tcpip_port

TCP/IP-port of the machine where d.3 search is installed.

Default value: 3406

From d.3 search 3.0 on, a d.3 gateway connection is also supported. The default port is then 3400.

Maximum number of full-text matches

FULLTEXT_FETCH_LIMIT

Sets the maximum number of results for the full-text-search.

Timeout for d.3 search

d3fc_dsearch_server_timeout

Maximum time in seconds for which d.3 waits for the result once it sends the request to the d.3 search. This parameter prevents a timeout of the d.3 processes, if the processing by d.3 search takes unexpectedly long.

Default value: 30

d.3 search pre-filter for property fields

DSEARCH_DIRECT_DOCFIELD_SEARCH

Enables the direct search of d.3 search for the document property fields. For a combined full-text- and property field-search, this reduces the result list of d.3 search and accelerates the further filtering by the d.3 server.

Default value: Yes

d.3 search standard corpus

DSEARCH_DEFAULT_CORPUS

Is used if no corpus for the document type was explicitly specified; when empty, this value is derived from the d.3 gateway server ID (d3[d3fc_server_id]).

Display of the data types

Warning

Since d.3 admin Version 7.2.0 the following parameters are no longer displayed and cannot be changed.

Exception: If the parameter was changed in an earlier d.3 admin version and therefore no longer contains the default value, then the parameter is still displayed.

With version 8.0 these parameters are no longer interpreted by the d.3 server!

Check before the update to version 8, if the previously mentioned parameters deviate on your system from the default values. If this is the case, do as follows:

  1. Check the applications communicating with the d.3 server (e.g. webservice, hostim-import directories, ...), to what extent the default values above are not used by the communication and edit these.

  2. Disable your regarding customer-specific configuration of d.3 server, by setting the default values for the parameters in d.3 admin.

Thousands-Separator for money-fields

FORMAT_7X_THOUSANDS_SEPARATOR

Default value: EMPTY

Decimal-Separator for money-fields

FORMAT_7X_DECIMAL_SEPARATOR

Default value: DOT

Minimum number of Decimal Digits for money-fields

FORMAT_7X_MIN_DECIMAL_DIGITS

Default value: 2

Maximum number of Decimal Digits for money-fields

FORMAT_7X_MAX_DECIMAL_DIGITS

Default value: 2

Thousands-Separator for numeric fields

FORMAT_8X_THOUSANDS_SEPARATOR

Default value: EMPTY

Decimal-Separator for numeric fields

FORMAT_8X_DECIMAL_SEPARATOR

Default value: DOT

Minimum number of Decimal Digits for numeric fields

FORMAT_8X_MIN_DECIMAL_DIGITS

Default value: 0

Maximum number of Decimal Digits for numeric fields

FORMAT_8X_MAX_DECIMAL_DIGITS

Default value: 2

LDAP

Time for synchronization of all d.3-LDAP-users

LDAP_USER_SYNC_TIME

If a time (format: hh:mm) is specified, then a synchronization of the d.3 user management directory service configured in the LDAP-administration module is performed every day at this time. In this case, new users and changed user settings for existing users are transferred to d.3.

Administrative LDAP-user name

LDAP_ADMIN_USER_NAME

If the specified directory service does not allow an anonymous login, then an LDAP-user name can be specified here, which is used during the synchronization to read all user values.

Password for the administrative LDAP-user

LDAP_ADMIN_USER_PASSWORD

If the specified directory service does not allow an anonymous login, then you can enter the password for the LDAP-user to be used during the synchronization here.

Read user data with administrative LDAP-user

LDAP_READ_ACCESS_ADMIN_USER

Enabling the parameter LDAP_READ_ACCESS_ADMIN_USER the user data are read by the administrative user (LDAP_ADMIN_USER_NAME) from the directory service and not from the login user itself (default).

This can be used, if security policies of the customer-IT only permit reading access to the directory tree for users with elevated rights. In this case, only the authentication (BIND) is performed with the user information of the login user. All reading accesses are now performed only by the administrative user.

Validity of the session-password

KERBEROS_SESSION_PASSWORD_DAYS

Validity of the session-password in days. After expiration of the password the system assigns a new password with the next logon.

Default value: 2

Creating session-passwords

LDAP_GENERATE_SESSION_PASSWORD

Default value: Yes

Enabling this parameter, the d.3 server creates session passwords, even if no Kerberos authentication is used.

This way, applications can sign in with the LDAP-user name as well as with the d.3 user name simultaneously for the same user account.

In analogy to the Kerberos-solution, with enabled LDAP-interface, a mixed mode of multiple applications of the same user is supported, disregarding of the fact, if these use the LDAP-user name or the d.3 user name.

However, this requires the support of session passwords by the client-applications. If this is ascertained, then the parameter can be enabled.

Note

For d.3 applications provided by d.velop this is the case since d.3 version 6.3.1.

If other, possibly customer-specific applications are used accessing d.3, then it must be checked, if these adopt the session-passwords returned by the d.3 server (see manual d.3 API; function ValidatePasswordForUser with the parameter package=Basic).

The parameter must be enabled in the following situations:

  • The LDAP interface is enabled.

  • Users are participating in a workflow via d.3 web and simultaneously also use other d.3 applications.

Example: A d.3 user uses d.3 smart explorer and takes part in a d.3 workflow via Microsoft Outlook.

In this case the parameter must be enabled for the simultaneous operation of the user account by d.3 smart explorer and d.3 web flow connector to work.

"new users only" mode for the LDAP-interface

LDAP_NEW_USER_ONLY_MODE

If this mode is enabled, then the LDAP-interface will only adopt new user in d.3 but will no longer apply changes to existing users.

This mode can be used, if the users are to be administrated and changed in d.3 admin.

The changes are then not overruled by the LDAP-interface.

The property and right definitions applied via LDAP then only affect the initial adoption of an LDAP user to d.3.

Default setting = 0 (disabled):

LDAP is the leading system for the d.3 user management.

Any changes in the LDAP configuration or to the data in the directory service are adopted in d.3.

Java/Groovy

Java/Groovy support

JAVA_SUPPORT

Enabling the support for die execution of Java and Groovy code in d.3.

Default value: No

Java Virtual Machine

JAVA_JVM_LIBRARY

Library with desired Java Virtual Machine. This is loaded on start of the d.3 processes to initialize the Java Runtime Environment.

Note

For the Oracle Java Runtime Engine (JRE) under Microsoft Windows, the jvm.dll and under Linux the libjvm.so is used.

JVM options

JAVA_JVM_OPTIONS

Options for the Java Virtual Machine For detailed information see the documentation of the Oracle Java HotSpot VM Options.

Example for setting JVM option values:

If you want to adjust the used memory of the JVM, this can be done via the options "-Xms" and "-Xmx". "-Xms" defines the default volume which is directly allocated. "-Xmx" defines the maximum volume of memory which may be allocated at maximum.

If you want that the default volume is 512 MB and a maximum of 1024 MB are to be allocated, then the configuration would look like the following:

-Xms512m -Xmx1024m

Note

A maximum of 1300 MB can be allocated because d.3 server is a 32-bit application.

Java CLASSPATH

JAVA_CLASSPATH

File path to the custom Java classes.

Here you can specify a directory, where the .class files are stored. Alternatively, you can enter the file name of a JAR file.

Several file names separated by a semicolon can be specified.

Java/Groovy API functions

JAVA_API_FUNCTIONS_DIR

Enables the plugin interface for API functions developed in Java or Groovy. Groovy scripts or JAR files, which implements d.3 API functions, are loaded from this directory.

Java Remote Debugging

JAVA_REMOTE_DEBUGGING

Start Java Virtual Machine in debug mode.

This allows to connect to the d.3 server process using the Remote Java Debugger to debug Groovy hooks executed in it.

The port 43400 is used for the communication. As each d.3 process starts its own Java Virtual Machine (JVM), the used ports are incremented.

The first process started with JAVA_REMOTE_DEBUGGING enabled opens port 43400, the second port 43401 etc.

The determined port will be displayed on start of the JVM by message "Java Remote Debugging Port” in the d.3 log.

Note

The JVM is started by d.3 on demand with the first access to Groovy code and is usually not available directly after process start.

Substitution rules

Redistribution of documents after x days

DISTRIBUTION_AFTER_CHECKOUT_DAYS

0: Documents are redistributed immediately after the checkout of a user.

> 0: Documents are redistributed by the d.3 async process ... days later.

Default value: 0

Ignore read mailbox entries

DOC_DISTRIBUTION_IGNORE_READ

If this option is enabled, then only the unread mailbox-entries are considered in the calculation of the workload balancing.

Default value: Yes

Document distribution to substitute

SEND_MAIL_TO_SUBSTITUTE

If a user checked out and a substitute is defined, then all mailbox-entries can be redistributed to the substitute. When checking in again, all unread entries can be returned to the actual recipient again. To enable this behavior, the parameter SEND_MAIL_TO_SUBSTITUTE must be enabled (= "1").

Default value: No

Consider read entries for document distribution

DISTRIBUTE_READ_DOCS

On activation the read mailbox entries are considered for the distribution to an adhoc-substitute, too.

This parameter affects to the parameters SEND_MAIL_TO_SUBSTITUTE and MAILBOX_SUBST_TYPE.

Note: After the distribution all mailbox entries are marked as unread for the substitute. If a back distribution takes place, all entries are marked as unread, too.

Type of the document distribution to the substitute

MAILBOX_SUBST_TYPE

With the parameter WV_SUBST_TYPE you can control, if the mailbox entries shall be copied (COPY) or moved (MOVE). If the entries are to be moved, then the unread entries are returned on checkin.

Default value: COPY

Copy to recipient

SEND_DOC_TO_ORIGIN

If a document is to be sent to a user who has checked out and entered a substitute, then this is sent to the substitute (usual behavior),

with enabled parameter SEND_DOC_TO_ORIGIN a copy is sent to the actual recipient.

Default value: No

Superior user in optional field of a user

SUPERIOR_IN_USER_OPT_FIELD

1-10: Number (1 to 10) of the optional user fields, where the d.3 user name of the superior is defined.

0: No superior user is defined.

If this value is set to "0" or the optional field with specified number is empty, then the superior is determined using the d.3 organizational structure. Else, this process overrides the d.3 organizational structure.

Default value: 0

Superior on the same level

SUPERIOR_SAME_LEVEL

When determining the superior of a user, all members of his activity profiles are also regraded as superiors. If this parameter is disabled, then the superior must be located at least one level higher in the organizational structure.

Default value: No

Rights validation with substitues at @D3USER

USER_MACRO_USE_SUBST

If you are using the macro @D3USER in a document class, the users defined as substitutes for the caller can also be included in the validation of rights. So the comparison of the character string will be done against the user name of the caller and the user name of the substitutes.

Default value: No

Rights management

Withdrawing the document processing as a superior

REVOKE_PROCESSING_SUPERIOR

Yes: If a document is located in the processing of a user, then only this user and his superior user may edit this document or change its status.

No: Every user with write-permissions for the document may withdraw the document whereby a warning is displayed for the revoking user.

Default value: No

Withdrawing the document as an administrator

REVOKE_PROCESSING_ADMIN

Yes: If a document is located in the processing of a user, then only this user and a d.3 administrator may edit this document or change its status.

No: Every user with write-permissions for the document may withdraw the document whereby a warning is displayed for the revoking user.

Default value: No

Checking rights when sending resubmissions

MAILBOX_CHECK_RECIPIENT_RIGHTS

On activation, it is checked before a Send to Mailbox (only individual recipients), if the recipient is eligible to view the document. If "no", an error message is displayed.

Default value: Yes

Checking rights after a property update

UPD_DOC_CHECK_NEW_CLASS

After an update of properties (UpdateAttributes), it is checked, for the document, if the user still has write-permissions to this document.

Default value: No

Additional rights validation while accessing files

EXTRA_RIGHT_CHECK_ON_FILE_ACCESS

By default, an access key is generated while searching for documents, which allows the d.3 application to display and download the physical files of the document for a limited period of time. If this parameter is enabled, an additional rights validation is synchronously performed while accessing the file. Enabling this parameter results in higher system load.

Automatic blocking on inactivity

BLOCK_USER_AFTER_DAYS

This specifies the number of days which may pass since the last logon of a user, before it is automatically blocked by the system.

Default value: 0 (no automatic blocking)

Automatic deactivation on inactivity

DISABLE_USER_AFTER_DAYS

This specifies the number of days which may pass since the last logon of a user, before it is automatically disabled by the system.

Default value: 0 (no automatic disabling)

Automatic removal on inactivity

REMOVE_USER_AFTER_DAYS

This specifies the number of days which may pass since the last logon of a user, before it is automatically removed by the system.

Default value: 0 (no automatic removal)

Other parameters

Color code for repository

ARCHIVE_COLOR_CODE

Defines the color for the repository icon.

0 (default): Red

1: Green

2: Blue

3: Purple

Sending of UDP packets for object monitor

UDP_SUPPORT

This parameter must be set to "Yes" for the d.3 server, d.3 hostimp and d.3 async to send regular UDP-packages to the monitoring service.

Default value: Yes

Abo service support (subscription service)

ABOSERVICE_SUPPORT

When enabling this parameter, the d.3 abo service (subscription service) process for the d.3 repository can be started and the context menu option Subscribe in the d.3 smart explorer is displayed. For users with an assigned e-mail address, the option is then enabled.

Default value: No

Default character-encoding

DEFAULT_CODEPAGE

This value should be set, if all previously stored document properties share the same character-encoding. If the repository contains documents with properties in various different character-encodings, then the value should remain set to "0". Otherwise, the clients might receive an incorrect character-encoding for existing documents.

Default value: 0

Translating datasets in search results

TRANSLATE_SEARCH_RESULTS

If this option is disabled, then the translation for static datasets are only displayed in the input forms (for the search and property change). If this parameter is enabled, then the current properties of a document are also displayed as translated.

Default: Yes

Syntax of regular expressions

REGEX_SYNTAX

If this option is disabled, then the translation for static datasets are only displayed in the input forms (for the search and property change). If this parameter is enabled, then the current properties of a document are also displayed as translated.

Default: Yes

By default, d.3 employs the 'POSIX Basic Regular Expression Syntax'. To be able to create more complex regular expressions, the 'POSIX Extended Regular Expression Syntax' or the 'PERL/JavaScript Regular Expression Syntax' can be used. These types feature a greater function set but differ from the 'basic syntax' in central points.

Warning

It is urgently recommended to check existing regular expressions in hooks, plausibility-checks of advanced property fields and document-class-filter, if they are compliant with the new syntax.

The 'POSIX Basic syntax' is basically compatible with the 'JPL syntax' but has more functions and is unicode-enabled. Please only use the 'JPL syntax', if you need to be 100% backward-compatible and you do not need the correct handling of unicode characters.

Note

You get the benefit of the "POSIX Extended Regular Expressions Syntax" using or-expressions.

Example: The regular expression "d.3 is (good|brilliant)!" allows the following examples: "d.3 is good!" or "d.3 is brilliant!".

Default value: POSIX Basic Regular Expression Syntax.

Interpret upper-/lower-case in regular expressions

REGEX_CASE

This specifies, if the interpretation of regular expression is to be case-sensitive. This setting has no effect, if the "JPL Regular Expression Syntax" is used.

Default value: case sensitive

Logging of job-runtime in the database

RUNTIME_INFO_DAYS_OF_DB_STORAGE

This variable specifies the number of days for which runtime information for the jobs processed by d.3 is maintained in the database table runtime_info. API-Call, asynchronous jobs and hostimport are saved based on total runtime, hook-runtime, SQL-runtime and time waiting for the file system. If this variable is set to “0”, then no information is logged in the database.

Default value: 0

Enable view displaying watermark

WATERMARK_SUPPORT

By enabling the parameter you can grant users document class rights so that these users are only allowed to view documents with watermarks.

Note

  • An installation of d.ecs pdf extension version 1.4.2 or higher is required.

  • The display of watermarks only works if the parameter V8RunningUpdateBackComp is disabled.

  • The display of watermarks is only valid for documents which are stored in PDF format.

Default value: 0

Audit-trail

Logging of changes made by users

AUDIT_USER_CHANGES

If this parameter is enabled, then modifications of users in not directly document-related data (e.g. Set Checkout Status or Change Password) in the database are logged.

Default value: No

Audited document types (complete)

audited_doc_types

Short name of the document types for which all modifications in the documents are to be logged in the audit-trail.

Audited document types (basic)

audited_doc_types_basic

Short name of the document types for which all modifications in the documents are to be logged in the audit-trail (whitout details).

Reproducibility of rendering and indexing

AUDIT_PROTOCOL_TIF_OCR

With enabled parameter the rendering and indexing of documents in the database can be exactly reproduced.

Notification in case of unauthorized access

AUDIT_LOG_ACCESS_DENIED

If the switch is enabled, unauthorized document access attempts are logged within the security context.

Key/Value-Cache (jStore)

jStore-bucket

KV_STORE_BUCKET

The name of the bucket (ID prefix) in jStore. If this parameter is unset, the value from parameter 'd3fc_server_id' will be used.

Asynchronous cache warming for imported documents

KV_STORE_IMPORTED_WARMING

d.3 async fills the key/value cache with the most recently imported documents.

Note

Independent of this parameter the cache is filled automatically by each search query.

Default value: No

Number of most recently imported documents

KV_STORE_ASYNC_IMPORTED_COUNT

This specifies the number of the most recently imported documents which d.3 async writes to the key/value cache. The latest documents are loaded into the cache until the here specified number is reached or no further documents exist in the cache.

Default value: 0

Asynchronous cache warming for imported documents

KV_STORE_HOLDFILE_WARMING

d.3 async also considers mailbox entries when filling the key/value cache.

Note

Independent of this parameter the cache is filled automatically by each search query.

Default value: 0

Number of mailbox entries

KV_STORE_ASYNC_HOLDFILE_COUNT

This specifies the number of mailbox entries which d.3 async writes to the key/value cache. Mailbox entries are loaded into the cache until the here specified number is reached or no further documents exist in the cache.

Default value: 0

Signature:

Check PDF-files for embedded signatures

SIGN_CHECK_PDF

If this parameter is enabled is, then imported PDF files (hostimport or API import) will be checked for embedded signatures. This requires d.ecs pdf extension (in version 1.2.0.1 or higher).

Default value: No

Default-verifier group for signed documents

SIGN_DEFAULT_GROUP

This parameter specifies the default-verifier group for documents which still have to be signed or whose signatures are not yet fully validated. If the document was imported with an invalid signature status, then the document is automatically imported into the verification of this group.

Default value: “”

Advanced optimizations

Database colums with static querying

STATIC_STATEMENT_COLUMNS

The d.3 system uses prepared statements with bind variables to process a large number of database accesses. This helps the database to work faster as the execution plans do not have to be created all over again, if only the value but not the structure of the query are changed.

However, there are situations, when the best execution plan of the database strongly depends on the passed values. A typical case are columns with a strongly uneven distribution of values, i.e. for example that most values exist only once but some values occur in millions of rows.

In this list, you can enter the columns whose comparison values should be statically written to the SQL queries instead of being used indirectly via Bind-variables.

Format: “table_name.column_name” (SQL wildcards % and _ are allowed in the column name)

Note

Note 1: The default behavior of d.3 is usually the best option. Please use this option only, if you encounter actual drops in performance that can be traced back to unfavorable execution plans. Remove these entries again if they do not yield any improvement.

Note 2: For some columns, d.3 uses static queries automatically without having to specify these columns here (e.g. if filtered indexes are used).

Note 3: This option affects most SQL queries created by d.3 but does not generally affect the all database access.

Number of the max. filtered document types by d.3 search

MAX_DOCTYPES_DSEARCH_FILTERING

Specifies the number of document types, which d.3 is maximum transmitting during the search to d.3 search.

A restriction of the document type can accelerate the full-text search and raise the precision of the results.

Note

This effect is especially big, if the number of potential results is reduced by the document type list.

If the number of chosen document types is too big, however, and is no insignificant restriction of the results, the filter in d.3 search can have a negative effect on the search performance.

If the list of document types exceeds the defined value, the filtering applies to document types after the full-text-query on d.3 server.

Activities

Show own activities on the Welcome page

HOME_ENABLE_OWN_ACTIVITIES

0: Own activities will not be displayed.

1: Own activities will be displayed.

Show all activities on the Welcome page

HOME_ENABLE_ALL_ACTIVITIES

0: All activities will not be displayed.

1: All activities will be displayed.

Anonymize user names

TIMESPAN_BEFORE_ANONYMIZE_ACTIVITIES

Default: 30

Always anonymize: 0

Never anonymize: -1

The user names will be anonymized after the period of time specified here when they are displayed.

Document types with minimal log level

DOC_TYPES_LOG_MINIMAL[1]

Short name of the document types with enabled minimal log level.

Events: Import, Import of a new version, property update, link documents and dossiers.

Document type with extended log level

DOC_TYPES_LOG_EXTENDED[1]

Short name of the document types with enabled extended log level.

Events: Status transfer, add and remove favorites, signing

Log level for the linking of documents and dossiers

LOG_LEVEL_LINK

Specifies from which log level the linking of documents is recorded in the history.

Log-Level: 1 = Minimum, 2 = Default, 3 = Extended

Log level for unlinking

LOG_LEVEL_UNLINK

Specifies from which log level the unlinking of documents is recorded in the history.

Log-Level: 1 = Minimum, 2 = Default, 3 = Extended

Log level for starting a workflow

LOG_LEVEL_START_WORKFLOW

Specifies from which log level starting a workflow is recorded in the history.

Log-Level: 1 = Minimum, 2 = Default, 3 = Extended

Log level for finishing a workflow

LOG_LEVEL_FINISH_WORKFLOW

Specifies from which log level finishing a workflow is recorded in the history.

Log-Level: 1 = Minimum, 2 = Default, 3 = Extended

Log level for sending a resubmission

LOG_LEVEL_SEND_HOLDFILE

Specifies from which log level sending a resubmission is recorded in the history.

Log-Level: 1 = Minimum, 2 = Default, 3 = Extended

Log level for forwarding a resubmission

LOG_LEVEL_FORWARD_HOLDFILE

Specifies from which log level forwarding a resubmission is recorded in the history.

Log-Level: 1 = Minimum, 2 = Default, 3 = Extended

Log level for acknowledging a resubmission

LOG_LEVEL_ACK_HOLDFILE

Specifies from which log level acknowledging a resubmission is recorded in the history.

Log-Level: 1 = Minimum, 2 = Default, 3 = Extended

Log level for adding a redlining

LOG_LEVEL_ADD_REDLINE

Specifies from which log level adding a redlining is recorded in the history.

Log-Level: 1 = Minimum, 2 = Default, 3 = Extended

Log level for removing a redlining

LOG_LEVEL_REMOVE_REDLINE

Specifies from which log level removing a redlining is recorded in the history.

Log-Level: 1 = Minimum, 2 = Default, 3 = Extended

Log level for adding a favorite

LOG_LEVEL_ADD_TO_FAVS

Specifies from which log level adding a favorite is recorded in the history.

Log-Level: 1 = Minimum, 2 = Default, 3 = Extended

Log level for removing a favorite

LOG_LEVEL_REMOVE_FROM_FAVS

Specifies from which log level removing a favorite is recorded in the history.

Log-Level: 1 = Minimum, 2 = Default, 3 = Extended

The writing of the history entries follows the following system:

  1. There are three different log levels: MinimalStandard and Extended

    1. Each document type belongs to the log level "Standard" by default with the exception of:

      1. DOC_TYPES_LOG_MINIMAL (the minimal log level)

      2. DOC_TYPES_LOG_EXTENDED (the extended log level)

        Note: This level can be read in the following form:

        "For a document type, all events are logged which have an event level <= of the log level of the document type."

  2. Each action (event) belongs either permanently or configurably to a certain log level

    1. For the following actions the log levels are freely configurable (d.3 config parameter):

      1. LOG_LEVEL_LINK

      2. LOG_LEVEL_UNLINK

      3. LOG_LEVEL_START_WORKFLOW

      4. LOG_LEVEL_FINISH_WORKFLOW

      5. LOG_LEVEL_SEND_HOLDFILE

      6. LOG_LEVEL_FORWARD_HOLDFILE

      7. LOG_LEVEL_ACK_HOLDFILE

      8. LOG_LEVEL_ADD_REDLINE

      9. LOG_LEVEL_REMOVE_REDLINE

      10. LOG_LEVEL_ADD_TO_FAVS

      11. LOG_LEVEL_REMOVE_FROM_FAVS

  3. The log levels/events are defined as follows:

    1. Minimal log level (so it is always written):

      1. Import

      2. Update_Client

      3. Update_Job

      4. Update_Server

      5. Update_Inherit

      6. ImportNewVersion_Client

      7. ImportNewVersion_Hostimp

      8. ImportNewVersion_Async

      9. StatusTransfer

      10. PublishForWeb

      11. ClientEvent (so specifically events triggered by the d3fc API)

    2. Standard log level:

      Any event that has not explicitly been assigned a minimal or extended log level (but is listed here):

      1. Import_Hostimp

      2. Import_Async

      3. LinkToChild_Job

      4. LinkToParent_Job

      5. AddNote

      6. Sign

      7. RegisterID

      8. UnregisterID

      9. DeleteVersion

    3. Extended log level:

      Only if explicitly defined by parameter (see listing 2.1).

  4. Exception:

    1. Depending on the parameter AUDIT_PROTOCOL_TIF_OCR , the following events are only logged for "Extended" document classes or not at all (parameter setting to 0 means no logging)

      1. RenditionJobCreated_001

      2. RenditionJobProcessed_001

      3. RenditionJobCreated_002

      4. RenditionJobProcessed_002

      5. RenditionJobCreated_003

      6. RenditionJobProcessed_003

      7. RenditionJobFinished

      8. RenditionJobFlagReset

      9. KeywordsSend_OnChangedType

      10. KeywordsSend_OnImport

      11. KeywordsSend_OnClientAPI

      12. KeywordsSend_OnChangedNote

      13. KeywordsSend_OnTranfer

      14. KeywordsSend_OnNewVesion

      15. KeywordsSend_OnRenderedOcr

      16. KeywordsSend_OnChangedAttribute

      17. KeywordsSend_OnSynchFile

      18. KeywordsSend_OnProcOCR001

      19. KeywordsSend_OnServerAPI

  • If an event of the level MINIMAL occurs (see 3.1.), this is logged in any case

  • If an event of level STANDARD occurs (see 3.2.), this is logged for documents which belong to a document class of level STANDARD or EXTENDED (see 1.1.).

    => i.e. conversely, the system does NOT log for documents of a document type that belong to the MINIMUM level.

  • If an event of level EXTENDED occurs (see 3.3. / 4.), this is logged for documents which belong to a document class EXTENDED (see 1.1.).

Transport system

Backup of the repository master data

MASTERDATA_BACKUP

Enables the automatic backup of the repository master data to be periodically performed by the d.3 async master process.

The time and interval are configured via the parameters MASTERDATA_BACKUP_TIME and MASTERDATA_BACKUP_INTERVAL.

The backup file is stored in the document tree under the directory config\d3admin\mdbackup.

Master data backup interval

MASTERDATA_BACKUP_INTERVAL

The master data backup will be done within fixed intervals. Valid values for MASTERDATA_BACKUP_INTERVAL are:

T: daily

W: weekly (on every Monday)

M: monthly (use MASTERDATA_BACKUP_DAYOFMONTH for setting up the day of month)

With MASTERDATA_BACKUP_TIME the time is specified, when the backup is to be executed.

Time stamp for the backup of all repository master data

MASTERDATA_BACKUP_TIME

Specify a time in the format "hh:mm".

Day of the month

MASTERDATA_BACKUP_DAYOFMONTH

Specifies the day of the month on which the backup is created. This only has an effect, if the parameter MASTERDATA_BACKUP_INTERVAL is set to "M".

E-mail notification

MASTERDATA_BACKUP_SENDMAIL

Enables the notification to be sent after the backup has been created.

"0": Do not notify

"1": Notify in case of errors

"2": Always notify

The parameters SMTP_SUPPORT and SMTP_GATEWAY must be set.

E-mail address

MASTERDATA_BACKUP_MAILADDRESS

E-mail adress for notification after backup.

Automatic import of repository master data files

MASTERDATA_IMPORT

Enabling this parameter you can configure the d.3 async master process to administrate repository master data such as users, user groups (e.g. create or update users) via control files/interface files. The automatic import is executed every 5 minutes.

Adoption of the storage settings for document type changes

MASTERDATA_TRANS_DTYPE_STORAGE_SETTINGS

By enabling the parameter the storage settings are overwritten for document type changes which are imported via transport files.

This affects the following settings:

- Time to live -> In months

- Time to live -> From

- Time to live -> Outsource to secondary storage

The settings "Time to live -> Event-based deletion" is not considered and thus is always transported.

More rules apply:

- When creating an new document type or changing a document type this parameter has no effect.

- Each change to the settings for the document types is recorded for the transport system and is written to the transport files.

- If a document type is transmitted to another d.3 repository via a transport file but the document type already exists, then the storage settings for disabled parameters will not be overwritten.

Adoption of the caching settings for document type changes

MASTERDATA_TRANS_DTYPE_CACHE_SETTINGS

By enabling the parameter the caching settings are overwritten for document type changes which are imported via transport files.

This affects the following settings:

- Retention time in cache -> In days

- Retention time in cache -> Allow removal ahead of schedule on lack of disk space

More rules apply:

- When creating an new document type or changing a document type this parameter has no effect.

- Each change to the settings for the document types is recorded for the transport system and is written to the transport files.

- If a document type is transmitted to another d.3 repository via a transport file but the document type already exists, then the caching settings for disabled parameters will not be overwritten.

d.3 presentation server

d.3 presentation server- hostname

PRESENTATION_SERVER_HOST

Hostname of the machine running d.3 presentation server.

d.3 presentation server - TCP/IP port

PRESENTATION_SERVER_PORT

TCP/IP Port under which d.3 presentation server is accessible.

Default value: 8081

d.3 presentation server - HTML path

PRESENTATION_SERVER_PORT

Contains the context path for d.3 presentation server.

d.3 presentation server- encryption

PRESENTATION_SERVER_SSL

If d.3 presentation server works with SSL, this parameter must be enabled.

d.3 presentation server- security level

PRESENTATION_SERVER_SECURITY_LEVEL

The security level determines which security features are used by d.3 presentation server and the applications.

0: The new security features will not be used.

1: The new security features will be used.

d.3 presentation server - expires time for URLs

PRESENTATION_SERVER_EXPIRES_SECS

If the security level is at least 1 the expires time of generated URLs by d.3 server is set to this value. The time is specified in seconds.

Default value: 60

d.3 presentation server - mapping of d3fc hosts to presentation server URIs

PRESENTATION_SERVER_MAPPING_D3FCHOST

Here the D3FC hosts are to be entered which are being assigned 1 to 1 (index number) to the corresponding PS-URIs.

(PRESENTATION_SERVER_MAPPING_PSURI)

d.3 presentation server - assignment presentation server URIs to d3fc hosts

PRESENTATION_SERVER_MAPPING_PSURI

Here the PS-URIs to the respective D3FC hosts are to be entered.

Example: https://ps-server:8444

(PRESENTATION_SERVER_MAPPING_D3FCHOST)

Note

For this mapping to take effect, no host must be specified in the d.3 config for PRESENTATION_SERVER_HOST.

This means, if no PRESENTATION_SERVER_HOST is defined, and "d3_host" is passed as an import parameter of the call, then this presentation server is returned. However, if none is passed, another mechanism applies and the server returns itself as the PS-host.

d.3 presentation server - Enables the HTTP interface of d.3 server

ENABLE_HTTP

Determines whether the HTTP interface of the d.3 server is enabled.

Configuration using the d3addon.ini

Some special parameters cannot be set using d.3 admin. These parameters can only be manually defined in the file d3addon.ini.

All parameters can be found together with a short description in the d3fixed.ini.

Having modified the d3addon.ini, you must restart the d.3 processes (d.3 server, d.3 hostimp and d.3 async) for the new configuration to be read properly.

Warning

Do not change the entries in the d3fixed.ini! Changes here can result a standstill of the d.3 repository and to loss of data.

Note

The capitalization is significant.

If you create a new repository with this version, then this repository is further defined with the following entries in the d3addon.ini file:

These parameters must not simply be set manually in an existing system, as they require according data structures which might have to be created during a migration.

This is also the reason, why those parameters are not all included in the d3config.ini.

Parameters configured in the d3config.ini as well as in the d3addon.ini require no migration but must not be set during updates as this might lead to faulty behavior, e.g. REVOKE_PROCESSING_ADMIN. For new installations these parameters can be set without risk as the new behavior is then usually desired.

In the following, all parameters which are preset in the d3addon.ini for new installations are explained.

CONFIG_PATH_D3CLIENT = "C\:\\d3\\D3T.dok\\config\\d3client"

Path to the directory containing the search templates as well as the client profile files (client config).

UTF8_SUPPORT = "1"

Enabling the unicode support of the d.3 repository.

SEARCH_DEP_DOCS_IN_DB = "1"

Information on the dependent files is read from the database and the information is managed here.

SUFFIX_DEP_DOCS_ARCHIVE_THREE_DIGITS = "1"

see the information on the old identifier

SUFFIX_ABH_ARCHIVE_DREIZIFFRIG in the d3fixed.ini.

TURBO_DOC_FLAGS_2 = "1"

Document flag information for the acceleration of the d.3 document search

SUBDIR_VERIFICATION = "1"

Create/use sub-directories in the d.3 doc tree for the verification directory

SUBDIR_ARCHIVE = "1"

Create/use sub-directories in the d.3 doc tree for the archive directory

SUBDIR_NOTES = "1"

Create/use sub-directories in the d.3 doc tree for the notes directory

SUBDIR_WFL_LOG = "1"

Create/use sub-directories in the workflow-protocol directory

REVOKE_PROCESSING_ADMIN = "1"

Allowing to revoke the processing version by an administrator

MODIFY_ATTR_DB_POSITION = "0"

Allowing/prohibiting the retroactive change of the database position of a property in the document type

ENABLE_DUMMY_WRITE_ACCESS = "0"

Withdrawing the write-permissions to dummy-document type

VALIDATE_NUMERIC_FIELDS = "1"

Enabling the verification if a numeric property only contains numeric characters.

OVERWRITE_NEW_ARCHIVE_PARAMS = "0"

Internal parameter specifying if the parameters for the initial creation were already written to the d3addon.ini.

WORKFLOW_NOTIFICATION_AUTO_ACKNOWLEDGE_ON_LOCK

1: 1: With the parameter you can control whether notifications from other users for a workflow step are to be automatically acknowledged. These notifications are no longer visible in the users' mailbox, if a user opened a workflow step for editing which is then locked.

0: If the notification has been sent via a group, then it is assigned to the caller and is then no longer visible for the other users.

D3_SERVER_HOST

Via the d.3 server config variable D3_SERVER_HOST the host name under which the d.3 server is externally accessible in cluster configurations can be specified. By this the default host name (d3fc_server_name) can be overwritten. This host name is then used for the creation of all workflow URLs. This affects the API functions GetPSUrl, LockWorkPathStep. This config variable can be set in the d3addon.ini.