Below, you can find the source code of the hook function generated for the task described above.

This file can be generated in a simple text editor like Notepad.

The file has got the name hook_dataset.jpl and has to be in the application directory of the d.3 server.

The left column in the table contains the line numbers. These are not part of the source code. They are only included to describe the source code.

###
# Modul zum Ermitteln einer Wertemenge in Abhängigkeit von DOK_DAT_FELD_1
###
call d3_server_api_error_log("Hook-Demo: Modul geladen", 1, 9)
proc BuildDataset(repos_id, user, doc_type_short, row_no)
{
  call d3_server_api_error_log("Hook-Demo: Modul aufgerufen", 1, 9)
  call d3_server_api_error_log("Hook-Demo: DOK_DAT_FELD_1 = :dok_dat_feld[1]", 1, 9)
  if (dok_dat_feld[1] = "Simply Save")
  {
    call d3_server_api_error_log("Hook-Demo: Simply Save", 1, 9)
  
    d3server_field_no_allowed  [1] = "" 
    d3server_value_char_allowed[1] = "File Storage Tool"
    d3server_date_1_array      [1] = ""
    d3server_value_num_allowed [1] = ""
    d3server_repos_id_allowed  [1] = repos_id
    d3server_field_no_allowed  [2] = "" 
    d3server_value_char_allowed[2] = "Screenshot Creator"
    d3server_date_1_array      [2] = ""
    d3server_value_num_allowed [2] = ""
    d3server_repos_id_allowed  [2] = repos_id
  }
  else if (dok_dat_feld[1] = "Total Sources")
  {
    call d3_server_api_error_log("Hook-Demo: Total Sources", 1, 9)
    d3server_field_no_allowed  [1] = "" 
    d3server_value_char_allowed[1] = "Total Sources Photo Editor"
    d3server_date_1_array      [1] = ""
    d3server_value_num_allowed [1] = ""
    d3server_repos_id_allowed  [1] = repos_id
    d3server_field_no_allowed  [2] = "" 
    d3server_value_char_allowed[2] = "Total Sources Video Editor"
    d3server_date_1_array      [2] = ""
    d3server_value_num_allowed [2] = ""
    d3server_repos_id_allowed  [2] = repos_id
  }
  return 0
}

The lines 1-3 are comments and have no influence on the application behavior. Line 4 generates a log file entry in the logviewer. This row displays at program start of the d.3 server the entry “hook-demo: module loaded" in the logviewer. If you configured all settings correctly, then this entry should be displayed in the logviewer as soon as the d.3 server is started. In line 9, another logviewer entry is generated. The content of doc_field_1 will be displayed here. It is important to use the “:” before the name of the field. Otherwise the entry would display the text “doc_feld[1]” instead of the field content.

Now, in row 11 the content of doc_field_1 will be requested. In case of the term “Simply Save”, the rows 14 - 26 will be run through and in case of the term “Total Sources”, it will be the rows 30 - 44.

The command in line 15 has to be given for compatibility reasons. In row 16 the first entry of the dataset will be assigned. Because in our example we want to assign the dataset to a alphanumeric advanced properties, it is necessary to use the global list (array) d3server_value_char_allowed. In case of a date field, the array must be d3server_date_1_array, while it would be d3server_value_num_allowed for a numeric value. The date must be entered in the German notation “DD.MM.YYYY”.

Finally in row 19 the ID of the advanced property field will be assigned to a global array. This ID is passed on to the hook-function by the d.3 server during the function call (line 6).

Further literature on the topic of “hook-development" can be requested from d.velop AG.

The basic element of the regular expressions is the single-character-pattern. When you use a single-character-patterns as a regular expression in d.3 then no other character than the one specified in the single-character-pattern itself can be entered.

Regular Expression	User input
A	A
A	B
A	Easy

Several characters or ranges can be combined to a set. The sets are entered in square brackets. A set in its entirety also serves as a single-character-pattern. This means, when using a set as a regular expression, the input is valid, if one of the characters in the set was entered.

Regular Expression	User input
[abc]	b (lower-case)
[abc]	D
[0-9]	F
[0-9]	7

Vice versa you can enter a set of characters as set , that is not allowed in the property value. To do so, enter as first character “^” in the value bracket. Please note that regular expressions differentiate between upper- and lower-case characters!

Regular Expression	User input
[^abc]	D
[^abc]	a (lower-case)

Finally, you can combine several single-character-patterns into a pattern. These patterns can also include sets. Ranges are validated against their ASCII value. Special characters like the German “Umlauts” or French accents have to be included in the pattern or they will not be accepted.

Regular Expression	User input
[A-ZÄÖÜ][a-zäöü][a-zäöü][a-zäöü]	John
[A-ZÄÖÜ][a-zäöü][a-zäöü][a-zäöü]	Saw
[A-ZÄÖÜ][a-zäöü][a-zäöü][a-zäöü]	Administrator	(only exact four characters are allowed)
[A-Z][a-z][a-z][a-z]	Saw	(ä is not allowed)

The colon (.) is a special regular expression. It serves as a wildcard for any character except #013 (carriage return).

Regular Expression	User input
[A-ZÄÖÜ].[0-9].	BE13
[A-ZÄÖÜ].[0-9].	A999
[A-ZÄÖÜ].[0-9].	A1

Multiplier characters designate how often a single-character-pattern can be entered:

Regular Expression	User input
Alpha.*	Alpha.*
Alpha.*	Alphabet
Alpha.*c	Alphanumeric
x\{3\}	X
x\{3\}	xxx
Yes\4\}!	Yes!
Yes\4\}!	Yeeees!
Cancel\{2,3\}ation	Cancelation
Cancel\{2,3\}ation	Neighbour

The button Test can be used to check a sample entry against the regular expressions. Enter a string in the field and click on Test.

For the user, the name of a document type is the most important property to differentiate between the document types. You will find this name in all d.3 applications.

The d.3 environment differentiates between document types and folder types.

The most significant difference is that dossiers can contain subordinate and superordinate documents.

In dossiers, usually no document is directly stored as they are only intended for the structured storage (as accustomed from paper archives).

The short name of a document-/dossier type is the unique identifier and the most important characteristic for processes and actions in the d.3 environment. The short name differentiates between lower- and upper-case characters. Hence, the two short names XFILE and Xfile designate two different types. The maximum length is five characters. The short name may only contain the following characters: "a..z", "A..Z", "0..9" and the minus character “-”.

Proposal for using a short name:

As the short name is displayed in case of errors in the central protocol, this significantly helps you at troubleshooting.

The d.3 repository supports several secondary storage systems via d.ecs storage manager which is controlling them. The secondary storage is addressed via d.ecs storage manager. You can store the documents in individual "logical" archives on the secondary storage medium.

For example, the documents of the type "Deliverynote" are to be stored in one logical archive (such as "DA" for "Deliverynote Archive") while those of the document type "Invoice" are stored in another one (such as "IA" for "Invoice Archive"). For this effect, the repository ID is used.

You can enter a maximum of two characters for the repository ID. Upper- and lower-case characters are supported. Currently, the number of repository ID’s is limited to five. The allowed IDs will be adjusted at the d.3 config in the section document storage. There, select the parameter server_archive_id_array. These settings can also be accessed from the point d.3 Document Storage choosing the option Additional Server IDs.

The unique identifier of documents (document ID) is generated using the repository ID. If, for example, you choose the repository ID "IN", then a document ID could be "IN500000".

Even if you are not using secondary storage, you can assign an repository ID. This way you could classify the document types and prepare the system for a later use of a secondary storage system. Once installed, the documents could then be moved to the secondary storage using this existing classification.

This setting is needed, if you want to use d.3 webpublisher by the d.velop AG .

This product enables the access to documents in the d.3 repository via the World Wide Web. The user does not have to authorize against the system here. There is therefore no query of the user name or password.

The software d.3 web publisher is not supplied with version 6.3 since it used the outdated technology of CGI scripts.

On opening the URL for d.3 webpublisher, all documents/dossier types which have been configured with the option Web published are displayed for search.

Within the web published document/dossier type, however, only those documents are displayed, which were previoulsy marked as published in d.3 smart explorer.

In order to publish documents in d.3 smart explorer, the file WebPub.DXP must be located in the working directory. If this file does not exist, you can either include it in the d.3 application distribution or manually copy it to the working directory. After copying the file manually, you must set its file property to “hidden” (command line call: attrib +h WebPub.DXP), to prevent a deletion with the next start of d.3 smart explorer.

Once the file exists in the directory you must restart d.3 smart explorer. Then, you can retrieve the documents to be web published in d.3 repository and choose Web published from the context-menu of the document.

Keep in mind that publishing is only possible for released documents.

If the menu entry Web published does not exist in d.3 smart explorer, then either d.3 smart explorer was not re-started or the file WebPub.DXP is not located in the d.3 smart explorer working directory.

If this option is active for a document or dossier type, the owner of a document assigned to this type is not permitted to verify a document himself (status Verification -> complete verification) even if he has the necessary rights. The editor is always the one holding the document in his processing while the owner is the user who stored the document in d.3 who created the release version in case of multiple versions.

This means, the editor (creator/modifier) of a document must be another person than the one verifying it.

The booking of documents is a special procedure of d.velop AG.

This procedure is used to create properties for a document, before the actual document is archived. In this procedure, the document is archived some time later (e.g. late capturing with barcode).

This procedure is used by d.3 import. If you change into the booking mode in d.3 import, only those document or folder types are displayed for selection, for which the option Book was set. Additionally, no document is stored whit a click on Book but only the attribute data are created in the d.3 repository.

Furthermore, a barcode cover page can be printed, which will be laid over the “analog” document at the clerk and afterwards it will be sent to the central scanning department. Using the barcode, the document is then mapped to the existing properties.

Please refer to the customizing manual for d.3 import to find out how the booking mode can be enabled.

During booking, an entry is made in the database table firmen_spezifisch when the properties (characteristic data) are created. By default, the entry in the database dok_dat_feld_88 is made. This default setting can be changed using the d.3 configuration. To do so, choose System settings > d.3 config > Import Settings > field number for barcode status the parameter BARCODE_STATUS_FIELD_NR.

When creating the attribute data, the value "0" (zero) is entered in this database column. This value specifies that no document exists for these property data yet. When the document (file) is imported at a later time, this entry is changed to the value "1" (one).

The lifetime is added as a value to the current date with every new version of a document and written as the retention period in the database.

You can define for each document type, if you want to use the Eventless deletion (previous default setting) or the Event-based deletion.

You can now define for event-independent deletion when the lifetime should begin.

By default, the lifetime will be specified from the import date, that means the count of months will be added to the import date and sets the retention period.

The lifetime can also be projected by the end of the selected month to comply with special requirements, e.g. the end of the quarter oder fiscal year.

This option specifies that the document/dossier types are to be written to the secondary storage system to store them in an audit-proof manner. Only the documents in the d.3 status "Release" and "Archive" are written to the secondary storage.

If the option Write to secondary storage is configured for a document type and you perform a status transfer (e.g. in d.3 smart explorer with a right-click and selection of Status transfer > Release, then the document is persistently written to the secondary storage.

If the event-based deletion is selected, then the retention period is determined via a defined event such as a product cancellation.

For more information see chapter Retention periods and deletion.

The actual deletion requires additional parameters in the d.3 configuration to be set (see d.3 Asynchronous processing).

From the d.3 version 7 a retroactive change of the database position is not possible. For an update to version 7 it is considered, that this was possible in older versions.

Alphanumeric fields 1 to 49This option changes the database position of the property field.

When changing the database position you must take account of the requirements for property:

If the parameter Mandatory is set on “Yes”, then the field has to be filled by import (manually oder hostimport) of the document. If the field is still empty at the storage of documents, an error message will be produced.

If this option is set on “Yes” (standard), then the property value can be edited after the import of the document. Else the change will not be applied.

If the property is thus defined for a document type as "protected" property, then its value can only be edited by an eligible user.

Title fields are used to improve the display of document properties in d.3 smart explorer.

If you open a document in d.3 smart explorer and select the context menu option Display Links, then you would usually see the document ID together with the name of the document type, e.g. "T000065565 Supplier Invoice".

If you want to use more descriptive identifiers, then you can choose one or multiple title fields. d.3 version 7.2 allows you to define different d.3 system fields as title fields.

This function allows you to prepare the properties in a document type for later hiding.

Via the rights management of document classes or profiles you can show the hidden property again.

This function is also available in the context menu > Hideable property or via the Properties dialog.

If a property is marked as hideable, then the icon in the overview is transparent:

In the overview of document types you can see that one property is marked as hideable:

As you can see in the illustration, the column Hideable must feature a "Yes" for a property to be hidden later, else the column contains "No".

To display hidden properties for individual users again, you must grant the right Read hidden properties and if necessary, Edit hidden properties.

Please also note the option to hide individual fields only for d.3 import or d.3 smart explorer.

The tab Extended allows settings for the conversion and display in d.3 import and the result list or the search form of d.3 smart explorer.

For each property, you can decide whether the values are to be displayed in upper-case, lower-case or in the original.

For category specific property fields in d.3 import or in d.3 smart explorer (search and result list), you can determine the display option in the section Visible in. If you disable an option, the property is no longer displayed in the feature.

Perform a search for the document type (category). In d.3 smart explorer, the d.3 users can display a property, which you have disabled under Visible in by doing as follows: