Configuring enaio
Valid for: enaio webclient version 8.50 SP1
The administration page gives administrators the option to change basic application settings, as well as to tailor the functionality of enaio to meet users' needs.
Configuring enaio:
- Open the administration page and log in with the access data of the technical user.
- Make the desired changes.
- Save and close.
The configuration is now adjusted. enaio users may have to log in again.
The following settings can be configured:


The connection data to enaio server and the access data of the technical user are specified during installation, and are therefore already entered on the administration page.
If you would like to change the connection data, edit the following parameters:
- IP address
- Port
- Technical user
- Password
- Session timeout
Parameter: |
com.os.osdrt.appserver.server |
Default value: |
127.0.0.1 |
Description: |
The IP address or DNS of the computer on which enaio server is installed. |
Parameter: |
com.os.osdrt.appserver.port |
Default value: |
4000 |
Description: |
The port used to access enaio server. |
Parameter: |
com.os.osdrt.appserver.mainuser |
Default value: |
root |
Description: |
The name of the technical user for the connection with enaio server. |
Parameter: |
com.os.osdrt.appserver.mainuserpwd |
Default value: |
optimal (encrypted) |
Description: |
The password of the technical user, used by enaio to connect to enaio server. |
Parameter: |
com.os.osdrt.session.timeout |
Default value: |
1800 |
Description: |
Length of inactivity (time specified in seconds) after which the user will need to log in again. -1 disables the timeout function. |

The log levels define the number of logged messages. Each log level also includes the messages of the levels above.
- Type and scope of log entries
- fatal: Messages for serious errors that could lead to the failure of the enaio system.
- error: Error messages
- warn: Warnings
- info: Information
- debug: Debug information to help with error analysis
- trace: More detailed information than the debug level, to help with error analysis.
Parameter: |
com.os.osdrt.loglevel |
Default value: |
warn |
Description: |
|
In the event that enaio malfunctions reproducibly, set a log level that is as detailed as possible, for example debug. Try to reproduce the error, and send the log files to OPTIMAL SYSTEMS GmbH for error analysis.


You can activate a file format check that only permits specified file formats to be inserted into documents with enaio. You thus prevent unsuitable files to be inserted in documents accidentally.
You can define a list of allowed file extensions for every document main type. Use commas to separate multiple file extensions.
- E-mail documents
- Color image documents
- Grayscale image documents
- Black-and-white image documents
- Video documents
- Windows Documents
- XML documents
Parameter: |
com.os.osdrt.file.validate.map.E-Doc |
Default value: |
mim, mime, msg, ima |
Description: |
Valid file extensions for e-mail documents. |
Parameter: |
com.os.osdrt.file.validate.map.P-Doc |
Default value: |
jpg, jpeg, gif, png, bmp |
Description: |
Valid file extensions for color image documents. |
Parameter: |
com.os.osdrt.file.validate.map.X-Doc |
Default value: |
jpeg, jpg |
Description: |
Valid file extensions for grayscale image documents. |
Parameter: |
com.os.osdrt.file.validate.map.D-Doc |
Default value: |
tif, tiff, asd |
Description: |
Valid file extensions for black-and-white image documents. |
Parameter: |
com.os.osdrt.file.validate.map.M-Doc |
Default value: |
avi, mpg, mpeg |
Description: |
Valid file extensions for video documents. |
Parameter: |
com.os.osdrt.file.validate.map.W-Doc |
Default value: |
doc, docx, docm, xls, xlsx, xlsm, ppt, pptx, pptm, pdf |
Description: |
Valid file extensions for Windows documents. This list is also valid for files that can be assigned to a module-spanning W-document in the variant administration. |
Parameter: |
com.os.osdrt.file.validate.map.XML-Doc |
Default value: |
xml |
Description: |
Valid file extensions for XML documents. Not all functions of the XML module are supported in enaio webclient. |
This configuration checks whether files to be imported have the extensions .jpg or .jpeg for all documents that will contain grayscale images:
com.os.osdrt.file.validate.map.X-Doc=JPG,JPEG
File names are not case-sensitive. Files with other extensions are not accepted for grayscale image documents with this setting.

You can specify whether data transfer will start automatically in a template when new documents are created from this template. Details for data transfer are found in the handbook 'OS_data-transfer.'
- Data transfer
- yes: Data transfer function enabled
- no: Data transfer function disabled
Parameter: |
com.os.osdrt.file.templatefilling |
Default value: |
no |
Description: |
|
Automatic data transfer can only be performed with enaio when creating a document. Hereby, there is no user interaction as data migration is a server-side process. Control characters contained in templates that require user interactions will be ignored.

You can specify whether document files are exported.
- Enable export
- yes: Document files can be exported.
- no: Document files cannot be exported.
Parameter: |
com.os.osdrt.exportfiles.enabled |
Default value: |
yes |
Description: |
|

- Enable merge
- yes: Multiple files can be merged into a PDF file for export.
- no: Multiple document files cannot be merged.
- Select documents
Parameter: |
com.os.osdrt.pdfmerge.enabled |
Default value: |
yes |
Description: |
|
Parameter: |
com.os.osdrt.pdfmerge.type.ids |
Default value: |
- |
Description: |
Comma-separated list of document type IDs that can be merged into a PDF file. If you leave this option empty, all document files can be converted to PDF. |


- Enable subscription
- yes: The subscription functions are available.
- no: The subscription functions are not available.
- Enabling user administration
- yes: Users with supervisor rights can use the user administration.
- no: The user administration is not available.
- Edit desktop
- yes: Users can edit their personal desktop.
- no: The personal desktop cannot be edited.
- Sending documents by e-mail
- yes: E-mails can be sent.
- no: E-mails cannot be sent.
- Configure double-click
-
EDIT_INDEX_DATA: Double-clicking on an object in the hit list will open the index data for editing.
-
SHOW_INDEX_DATA: Double-clicking on an object in the hit list will open the index data in read-only mode.
-
EDIT_CONTENT_DATA: Double-click on object in hit list to check out the document and download it. In the case of image documents (color image, grayscales, etc.), a dialog opens for editing the content. In the case of W-documents, the document is downloaded immediately. If the document is already checked out, an information dialog will be displayed.
-
EXPORT_CONTENT_DATA: Double-clicking on an object in the hit list will offer document content for download. Requires the system role "Export from hit list."
-
EXPORT_CONTENT_AS_PDF: Double-clicking on an object in the hit list will offer document content as PDF for download. Requires the system role "Export from hit list."
-
PRINT_CONTENT_AS_PDF: Double-click on object in hit list offers document content as PDF for download. In the case of image documents, each image is additionally marked with a watermark. Requires the system role "Print documents."
- Send e-mail to external recipient
- Changing the password
- yes: Users can change their password.
- no: The password change function is not available.
- Open location
- yes: Users can open the location of documents and registers.
- no: The location feature is not available.
- Enable variant administration
- yes: Users can manage multiple variants of W-Documents.
- no: The variant administration is not available.
- Enable follow-up
- yes: The follow-up functions are available.
- no: The follow-up functions are not available.
- Enable clipboard
- yes: Documents, registers, and folders can be saved to the clipboard for later use, e.g. for copying.
- no: The clipboard is not available.
Parameter: |
com.os.osdrt.abo.enabled |
Default value: |
yes |
Description: |
|
Parameter: |
com.os.osdrt.usermanagement.enabled |
Default value: |
no |
Description: |
|
Parameter: |
com.os.osdrt.desktop.edit |
Default value: |
yes |
Description: |
|
Parameter: |
com.os.osdrt.sendlink |
Default value: |
yes |
Description: |
|
Parameter: |
|
Default value: |
EDIT_INDEX_DATA |
Description: |
For all content actions (EDIT_CONTENT_DATA, EXPORT_CONTENT_DATA, EXPORT_CONTENT_AS_PDF and PRINT_CONTENT_AS_PDF), the standard action (EDIT_INDEX_DATA) is executed for folders, registers, and documents without content or missing rights. |
Parameter: |
com.os.osdrt.smtpserver |
Default value: |
- |
Description: |
If you specify an e-mail server here, documents can also be sent via email to users who do not have an enaio user account. |
Parameter: |
com.os.osdrt.changepwd |
Default value: |
yes |
Description: |
|
Parameter: |
com.os.osdrt.location.enable |
Default value: |
yes |
Description: |
|
Parameter: |
com.os.osdrt.variant.administration.enabled |
Default value: |
yes |
Description: |
|
Parameter: |
com.os.osdrt.revisit.enabled |
Default value: |
yes |
Description: |
|
Parameter: |
com.os.osdrt.clipboard |
Default value: |
yes |
Description: |
|

By default, users can add annotations in text form anywhere in the content preview.
To make full use of the annotation function, users need the system roles Show preview annotations, Edit preview annotations, and Export from hit list.
The annotation function can be disabled by revoking the system roles Show preview annotations and Edit preview annotations. The system role Export from hit list will still be required for other functions.


- Show desktop
- yes: The desktop will be shown in the navigation area.
- no: The desktop is disabled.
- Show references to objects
- yes: References to documents, registers, and folders will be shown on the desktop.
- no: References to documents, registers, and folders will not be shown.
- Show references to search requests
- yes: References to saved searches will be shown on the desktop and in the quick search.
- no: References to saved searches will not be shown.
Parameter: |
com.os.osdrt.desktop.folder |
Default value: |
yes |
Description: |
|
Parameter: |
com.os.osdrt.desktop.object |
Default value: |
yes |
Description: |
|
Parameter: |
com.os.osdrt.desktop.query |
Default value: |
yes |
Description: |
|

Here users can find the object search, desktop, quick search, and inbox areas. To hide the main menu, the following parameters must be set to no:
- com.os.osdrt.workflow
- com.os.osdrt.abo.enabled
- com.os.osdrt.revisit.enabled
- com.os.odrt.search.enabled
- com.os.osdrt.desktop.folder

The dashboard is part of the standard home page. Here users can find the inboxes and a selection of saved searches.
To hide the dashboard, the following parameters must be set to no:
- com.os.osdrt.desktop.folder
- com.os.osdrt.desktop.query

The navigation pane will be shown expanded for new users by default.
- Expand navigation
- yes: Expanded
- no: Collapsed
Parameter: |
com.os.osdrt.ui.default.shownavigation |
Default value: |
yes |
Description: |
|


- Automatically show register location
- yes: The register location will be shown once you have clicked on a register on the hit list.
- no: The register location will not be shown.
Parameter: |
com.os.osdrt.location.container.automatic |
Default value: |
no |
Description: |
|

- Enable hit list export
- yes: Users can export hit lists.
- no: Hit lists cannot be exported.
- Separator between the column contents to be exported
- Masking character for the column contents to be exported
- Export column names
- yes: The header column names at the top of the hit list will be exported.
- no: The header column names at the top of the hit list will not be exported.
Parameter: |
com.os.osdrt.exporthits.enabled |
Default value: |
yes |
Description: |
|
Parameter: |
com.os.osdrt.exporthits.delimiter |
Default value: |
; |
Description: |
e.g. \t for tab character or ; for Excel-style export |
Parameter: |
com.os.osdrt.exporthits.quote |
Default value: |
\" |
Description: |
e.g. \" for export with quotation marks |
Parameter: |
com.os.osdrt.exporthits.exporthead |
Default value: |
yes |
Description: |
|

Documents will only be returned as hits during searches if both the logged-in user and the technical user have access rights to them.
- Enable full text search
- yes: Users can use the full-text search.
- no: The full-text search is not available.
- Maximum number of hits in a hit list per object type
-
If set to -1, all results will always be shown.
This setting may reduce performance. - The value 0 is invalid and will be automatically set to 200.
- Show object search
- yes: The Object search area will be shown in the main menu.
- no: The 'Object search' area will not be shown.
- Support for basic parameters
-
yes: Basic parameters will be taken into account for search requests.
-
no: Basic parameters will not be taken into account for search requests.
Parameter: |
com.os.osdrt.fulltext.use |
Default value: |
yes |
Description: |
|
Parameter: |
com.os.osdrt.table.max.hitcount |
Default value: |
200 |
Description: |
Only the specified number of hits will be transferred from enaio server to enaio, even if more hits exist. |
Parameter: |
com.os.odrt.search.enabled |
Default value: |
yes |
Description: |
|
Parameter: |
com.os.osdrt.baseparams.use |
Default value: |
yes |
Description: |
|

Using the workflow components, users perform tasks such as starting workflows and editing work items. Use the following parameters to configure the integration of the workflow area with the inboxes:
- Enable workflow
-
yes: The workflow functions are available.
-
no: The workflow functions are not available.
- Open workflow inbox automatically
-
yes: The workflow inbox will open automatically after logging in to enaio.
-
no: The workflow inbox will not be opened.
Parameter: |
com.os.osdrt.workflow |
Default value: |
yes |
Description: |
|
Parameter: |
com.os.osdrt.autostart.workflow.open.inbox |
Default value: |
no |
Description: |
|
© Copyright OPTIMAL SYSTEMS 2020. | Legal and Data Privacy