Skip to content

Commit 207021e

Browse files
committed
Update configuration-files.md
1 parent 18fa3cb commit 207021e

File tree

1 file changed

+54
-7
lines changed

1 file changed

+54
-7
lines changed

docs/abcd-administration/system-databases/configuration-files.md

Lines changed: 54 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,62 @@ Located typically in the `cgi-bin` directory (or defined by the `cipar` paramete
1515
users=%path_database%users/data/users
1616
books=%path_database%books/data/books
1717
log=%path_database%log/data/log
18-
1918
```
2019

21-
## `dr_path.def` (Path Definition)
20+
---
21+
22+
## `dr_path.def` (Path and Advanced Definitions)
23+
24+
Located inside each database folder (e.g., `/bases/books/dr_path.def`), this file contains a series of parameters used to activate special options for database management, file uploads, permissions, default sorting, and digital document routing.
25+
26+
### General & System Parameters
27+
* **`UNICODE`**: Establishes the character set used by the database.
28+
* `1`: UNICODE (UTF-8)
29+
* `0` (or omitted): ANSI (ISO-8859-1)
30+
* *Note: This is mandatory if the `MULTIPLE_DB_FORMATS` parameter is set in `abcd.def`.*
31+
* **`CISIS_VERSION`**: Defines the version of CISIS to be used to manage the database. The combination of `UNICODE` and `CISIS_VERSION` determines the specific subfolder inside the `cgi-bin` directory from where the `wxis` executable will be invoked.
32+
* **`leader`**: The tag of the field where the "leader" information is stored for MARC records. If omitted, the leader information is stored starting at field `3000-`.
33+
34+
### Record Sorting Options
35+
These parameters define the default sorting behavior for database records:
36+
* **`SORTLENGTH`**: Defines the default sort key length. The value must be greater than zero (`>0`).
37+
* **`SORTBY`**: Determines the default sorting method. It can be set to sort by a specific **Tag** or by a custom **Format**.
38+
* **`SORTSPEC`**: Specifies the exact sorting criteria based on your `SORTBY` selection.
39+
* *For Tag:* Enter the integer tag number.
40+
* *For Format:* Enter the specific specification string (in ISIS formatting language) used to generate the sort keys.
41+
42+
### Security & Access Control
43+
* **`VALID_IP`**: Restricts access to the database based on the client's internet IP address. You can define valid IPs separated by commas (`,`). An empty value allows access from all addresses. Entering `None` strictly limits access to local network addresses.
44+
* *Note: Link-Local Addresses are always allowed by design.* * For detailed configuration instructions, please refer to the [Database IP Access Control](../access-management/ip-access-control) documentation.
45+
46+
### Inventory & Barcodes
47+
* **`inventory_numeric`**: Determines if leading zeros should be removed when scanning an item's barcode in the circulation module. (`Y` = strip leading zeros; `N` = keep leading zeros).
48+
* **`max_inventory_length`**: Indicates the maximum, fixed length of the inventory number. Missing positions are automatically padded with zeros (e.g., if set to `8`, an entered value of `567` is saved as `00000567`). This applies to the `copies` database.
49+
* **`max_cn_length`**: Indicates the maximum, fixed length of the control number, padded with zeros just like the inventory parameter. This is used when assigning control numbers via the database utilities.
50+
* **`barcode`**: Displays the barcode icon in the cataloging module toolbar to trigger the batch printing of barcodes and labels. (The operator must have the required permissions).
51+
52+
### Thesaurus & Directory Browsing
53+
* **`tesaurus`**: The name of the Thesaurus associated with the database.
54+
* **`prefix_search_tesaurus`**: The search prefix added to the thesaurus term when executing a search in the associated database.
55+
* **`dirtree`**: Enables (`Y`) or disables (`N`) exploring the database folder structure. To use this in the Utilities menu, the user must be a system admin, have central module permissions, or possess the `EXBDIR=Y` permission in their profile.
56+
* **`DIRTREE_EXT`**: Defines the allowed file extensions when browsing directories (bases, par, www, or wrk).
57+
* *Default:* `*.def,*.iso,*.png,*.gif,*.jpg,*.pdf,*.xrf,*.mst,*.n01,*.n02,*.l01,*.l02,*.cnt,*.ifp,*.fmt,*.fdt,*.pft,*.fst,*.tab,*.txt,*.par,*.html,*.zip`
2258

23-
Located inside each database folder (e.g., `/bases/books/dr_path.def`). It controls permissions and paths for file uploads (images, digital documents) specific to that database.
59+
### User Interface (UI) Customization
60+
You can change the appearance and logo of the interface for a specific database folder:
61+
* **`CSS_NAME`**: The name of the folder containing the custom CSS style files.
62+
* **`LOGO`**: The path to the specific logo for this database (e.g., `../css/Folder_Name/Logo_Name.png`).
2463

25-
**Key Settings:**
64+
### Digital Documents & Storage
65+
* **`ROOT`**: The absolute, full path specifying where digital documents are stored if they are located outside the server's root directory (e.g., `ROOT=/bases/biblo/documents/`).
66+
* **`collection`**: Specifies the subfolder used for storing digital objects linked to the records.
2667

27-
* `ROOT`: The physical root folder for documents.
28-
* `collection`: Subfolder for digital objects.
29-
* `unicode`: Defines if the database uses UTF-8 (1) or ANSI (0).
68+
### iAH Full-Text Access Control
69+
If you need to require a password to read the full-text version of protected documents via the iAH interface, the following parameters are used:
70+
* **`DB_PATH`**: The path where the respective database is located (required for iAH since it bypasses Central ABCD configs).
71+
* **`USER_SEARCH`**: The prefix used to locate the user's code.
72+
* **`USER_DISPLAY`**: The PFT format used to display the user's name.
73+
* **`DOCUMENT_DISPLAY`**: The PFT format used to display a brief reference to the selected document.
74+
* **`DOCUMENT_NAME`**: The PFT format used to extract the exact filename of the document to be shown.
75+
* **`HTTP_ACCESS`**: If documents are in the server root, this indicates the base URL to prepend to the filename.
76+
* **`FILE_ACCESS`**: If the document is outside the server root, this specifies the path to prepend before the document name. If omitted, the `ROOT` parameter path is used.

0 commit comments

Comments
 (0)