enaio® webclient

enaio® webclient • 9.10 »

The administration console gives administrators the option to change basic application settings, as well as to tailor the functionality of enaio® webclient to meet users' needs.

Configuring enaio® webclient:

  1. Open the administration console and log in with the access data of the technical user.
  2. Make the desired changes.
  3. Save and close.

The configuration is now adjusted. enaio® users may have to log in again.

The following settings can be configured:

The enaio® server connection data and the access data of the technical user are specified during installation and are therefore already entered on the administration console.

If you would like to change the connection data, edit the following parameters:

  • IP address

    • 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.
  • Port

    • Parameter:

    com.os.osdrt.appserver.port

    Default value:

    4000

    Description:

    The port used to access enaio® server.
  • Technical user

    • Parameter:

    com.os.osdrt.appserver.mainuser

    Default value:

    -

    Description:

    The name of the technical user for the connection with enaio® server that was specified during installation.
  • Password

    • Parameter:

    com.os.osdrt.appserver.mainuserpwd

    Default value:

    - (encrypted)

    Description:

    The password of the technical user for the connection with enaio® server that was specified during installation.
  • Session timeout

    • 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

    • Parameter:

    com.os.osdrt.loglevel

    Default value:

    warn

    Description:
    • 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, used to help with error analysis.

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.

Observing the guidelines for form design means that forms can be designed using responsive design enabling a high degree of consistency in form presentation in enaio® client and enaio® webclient.

Parameter:

com.os.osdrt.ui.responsive.mask.layout

Default value:

yes

Description:

  • yes: Responsive design enabled

  • no: Responsive design disabled

    Please note that the option to use responsive design will no longer be available in a future version, if you do not activate it, and it is mainly intended help bridge the gap for the change of form design.

This setting allows to restrict login to user agents

Parameter:

com.os.osdrt.user.agent.restrictions

Default value:

No value: no restriction to user agents

Description:

User agents are specified in a comma-separated list

You can activate a file format check that only permits specified file formats to be inserted into documents using 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.

  • Color image 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.
  • Grayscale image documents

    • Parameter:

    com.os.osdrt.file.validate.map.X-Doc

    Default value:

    jpeg, jpg

    Description:

    Valid file extensions for grayscale image documents.
  • Black-and-white 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.
  • Video documents

    • Parameter:

    com.os.osdrt.file.validate.map.M-Doc

    Default value:

    avi, mpg, mpeg

    Description:

    Valid file extensions for video documents.
  • Windows 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.
  • XML documents

    • Parameter:

    com.os.osdrt.file.validate.map.XML-Doc

    Default value:

    xml

    Description:

    Valid file extensions for XML documents. Not all features 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 'OS_data-transfer' manual.

  • Data transfer

    • Parameter:

    com.os.osdrt.file.templatefilling

    Default value:

    no

    Description:
    • yes: Data transfer function enabled
    • no: Data transfer function disabled

Automatic data transfer can only be performed using enaio® when creating a document. There is no user interaction in the process as data transfer is a server-side process. Control characters contained in data transfer templates that require user interactions will be ignored.
If templates for Office formats and applications other than the supported formats – Word, Excel, PowerPoint – are integrated, then creating documents using these templates with data transfer activated will result in errors.

You can specify whether document files are exported.

  • Enabling export

    • Parameter:

    com.os.osdrt.exportfiles.enabled

    Default value:

    yes

    Description:
    • yes: Document files can be exported.
    • no: Document files cannot be exported.
  • Enabling merge

    • Parameter:

    com.os.osdrt.pdfmerge.enabled

    Default value:

    yes

    Description:
    • yes: Multiple files can be merged into a PDF file for export.
    • no: Multiple document files cannot be merged.
  • Selecting documents

    • 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.

The synchronization for the offline mode of enaio® webclient as a desktop application and enaio® mobile checks whether all previews are up-to-date. For performance reasons, only default file formats for which it is assumed that previews can be created are checked. If you use other file formats for which previews can be created, then specify such file formats as a comma-separated list of formats. All file formats will be checked if you enter the '*' placeholder.

Parameter:

com.os.osdrt.offline.rendition.additional.suffixes

Default value:

-

Description:

Comma-separated list of file formats

 

Default file formats

bmp

csv

dib

doc

docm

docx

dot

dotx

dwg

dxf

emf

eml

epdf

epi

eps

epsf

epsi

exr

gif

ico

jpeg

jpg

mim

mpp

mpt

msg

odg

odp

ods

odt

pbm

pcx

pdf

png

pnm

pot

potm

potx

pps

ppsm

ppsx

ppt

pptm

pptx

ps

ps2

ps3

psd

ptif

rtf

svg

svgz

sxc

sxi

sxw

tif

tiff

wbmp

wmf

wps

xbm

xcf

xls

xlsb

xlsm

xlsx

xltm

xltx

xmind

xml
  • Enabling subscriptions

    • Parameter:

    com.os.osdrt.abo.enabled

    Default value:

    yes

    Description:
    • yes: The subscription functions are available.
    • no: The subscription functions are not available.
  • Enabling user administration

    • Parameter:

    com.os.osdrt.usermanagement.enabled

    Default value:

    no

    Description:
    • yes: Users with supervisor rights can use the user administration.
    • no: The user administration is not available.
  • Downloading the desktop application enaio® webclient-app

    • Parameter:

    com.os.osdrt.disable.desktop.app.download

    Default value:

    no

    Description:
    • yes: The download of enaio® webclient-app is not offered.
    • no: The download is offered.

      • enaio® webclient-app requires .NET with version 4.6 or higher at the workstation.

      Users do not need administrator rights to install.
  • Editing the desktop

    • Parameter:

    com.os.osdrt.desktop.edit

    Default value:

    yes

    Description:
    • yes: Users can edit their personal desktop.
    • no: The personal desktop cannot be edited.
  • Sending documents by e-mail

    • Parameter:

    com.os.osdrt.sendlink

    Default value:

    yes

    Description:
    • yes: E-mails can be sent.
    • no: E-mails cannot be sent.
  • Configuring double-click

    • Parameter:

    com.os.osdrt.hitlist.document.doubleclick.action

    Default value:

    EDIT_INDEX_DATA

    Description:

    • EDIT_INDEX_DATA: Double-clicking an object in the hit list will open the index data for editing.

    • SHOW_INDEX_DATA: Double-clicking an object in the hit list will open the index data in read-only mode.

    • EDIT_CONTENT_DATA: Double-clicking an object in the hit list will 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 will be downloaded immediately. An information dialog will be shown if the document is already checked out.

    • EXPORT_CONTENT_DATA: Double-clicking 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 an object in the hit list will offer document content as a PDF for download. Requires the system role "Export from hit list."

    • PRINT_CONTENT_AS_PDF: Double-clicking an object in the hit list offers document content as a PDF for download. In the case of image documents, each image is additionally marked with a watermark. Requires the system role "Print documents."

    For all content actions (EDIT_CONTENT_DATA, EXPORT_CONTENT_DATA, EXPORT_CONTENT_AS_PDF and PRINT_CONTENT_AS_PDF), the default action (EDIT_INDEX_DATA) is executed for folders, registers, and documents without content or missing rights.
  • Hit list with one hit

    • Parameter:

    com.os.osdrt.hitlist.document.singlehit.action

    Default value:

    NONE

    Description:

    • NONE: No action.

    • EDIT_INDEX_DATA: Opens the index data for editing.

    • SHOW_INDEX-DATA: Opens the index data for viewing.

    • EDIT_CONTENT_DATA: Checks out the document and downloads 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 will be downloaded immediately. An information dialog will be shown if the document is already checked out.

    • EXPORT_CONTENT_DATA: Offers document content for download. Requires the system role "Export from hit list."

    • EXPORT_CONTENT_AS_PDF: Offers document content as a PDF for download. Requires the system role "Export from hit list."

    • PRINT_CONTENT_AS_PDF: Offers document content as a PDF for download. In the case of image documents, each image is additionally marked with a watermark. Requires the system role "Print documents."

    For all content actions (EDIT_CONTENT_DATA, EXPORT_CONTENT_DATA, EXPORT_CONTENT_AS_PDF and PRINT_CONTENT_AS_PDF), the default action (NONE) is executed for folders, registers, and documents without content or missing rights.
  • Sending e-mails to external recipients

    • Parameter:

    com.os.osdrt.smtpserver

    Default value:

    -

    Description:

    If you specify an e-mail server here, documents can also be sent via e-mail to users who do not have an enaio® user account.
  • Changing the password

    • Parameter:

    com.os.osdrt.changepwd

    Default value:

    yes

    Description:
    • yes: Users can change their password.
    • no: The password change function is not available.
  • Opening locations

    • Parameter:

    com.os.osdrt.location.enable

    Default value:

    yes

    Description:
    • yes: Users can open the filing location of documents and registers.
    • no: The filing location feature is not available.
  • Enabling variant administration

    • Parameter:

    com.os.osdrt.variant.administration.enabled

    Default value:

    yes

    Description:
    • yes: Users can manage multiple variants of W-Documents.
    • no: The variant administration is not available.
  • Enabling follow-ups

    • Parameter:

    com.os.osdrt.revisit.enabled

    Default value:

    yes

    Description:
    • yes: The follow-up functions are available.
    • no: The follow-up functions are not available.
  • Enabling the clipboard

    • Parameter:

    com.os.osdrt.clipboard

    Default value:

    yes

    Description:
    • yes: Documents, registers, and folders can be saved to the clipboard for later use, such as for copying.
    • no: The clipboard is not available.

By default, users can add annotations in text form anywhere in the document preview.

To make full use of the annotation function, users need the system roles View preview annotation, Edit preview annotation, and Export from hit list.

The annotation function can be disabled by revoking the system roles View preview annotation and Edit preview annotation. The system role Export from hit list will still be required for other functions.

  • Showing the desktop

    • Parameter:

    com.os.osdrt.desktop.folder

    Default value:

    yes

    Description:
    • yes: The desktop will be shown in the Navigation area.
    • no: The desktop is disabled.
  • Showing references to objects

    • Parameter:

    com.os.osdrt.desktop.object

    Default value:

    yes

    Description:
    • yes: References to documents, registers, and folders will be shown on the desktop.
    • no: References to documents, registers, and folders will not be shown.
  • Showing references to search requests

    • Parameter:

    com.os.osdrt.desktop.query

    Default value:

    yes

    Description:
    • yes: References to saved search requests will be shown on the desktop and in the quick search.
    • no: References to saved search requests will not be shown.

Users can find the Object search, Desktop, Quick search, and Inbox areas here. 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 screen. 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 area will be shown expanded for new users by default.

  • Expanding the navigation

    • Parameter:

    com.os.osdrt.ui.default.shownavigation

    Default value:

    yes

    Description:
    • yes: Expanded
    • no: Collapsed
  • Showing register location automatically

    • Parameter:

    com.os.osdrt.location.container.automatic

    Default value:

    no

    Description:
    • yes: The register location will be shown once you have clicked a register in the hit list.
    • no: The register location will not be shown.
  • Enabling the hit list export

    • Parameter:

    com.os.osdrt.exporthits.enabled

    Default value:

    yes

    Description:
    • yes: Users can export hit lists.
    • no: Hit lists cannot be exported.
  • Separator between the column contents to be exported

    • Parameter:

    com.os.osdrt.exporthits.delimiter

    Default value:

    ;

    Description:

    for example, \t for tab character or ; for Excel-style export
  • Masking character for the column contents to be exported

    • Parameter:

    com.os.osdrt.exporthits.quote

    Default value:

    \"

    Description:

    for example, \" for export with quotation marks
  • Exporting column names

    • Parameter:

    com.os.osdrt.exporthits.exporthead

    Default value:

    yes

    Description:
    • 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.

Documents will only be returned as hits during searches if both the logged-in user and the technical user have access rights to them.

  • Enabling full-text search

    • Parameter:

    com.os.osdrt.fulltext.use

    Default value:

    yes

    Description:
    • 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

    • 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.

    • 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.
  • Showing the object search

    • Parameter:

    com.os.odrt.search.enabled

    Default value:

    yes

    Description:
    • 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

    • Parameter:

    com.os.osdrt.baseparams.use

    Default value:

    yes

    Description:

    • yes: Basic parameters will be taken into account for search requests.

    • no: Basic parameters will not be taken into account for search requests.

Users have the workflow components for performing tasks such as starting workflows and editing work items. Use the following parameters to configure the integration of the workflow area with the inboxes:

  • Enabling the workflow

    • Parameter:

    com.os.osdrt.workflow

    Default value:

    yes

    Description:

    • yes: The workflow functions are available.

    • no: The workflow functions are not available.
  • Opening the workflow inbox automatically

    • Parameter:

    com.os.osdrt.autostart.workflow.open.inbox

    Default value:

    no

    Description:

    • yes: The workflow inbox will open automatically after logging in to enaio®.

    • no: The workflow inbox will not be opened.

Thousands separators for decimal numbers can be configured:

  • Thousands separators

    • Parameter:

    com.os.osdrt.ui.thousandseparator.de

    com.os.osdrt.ui.thousandseparator.en

    com.os.osdrt.ui.thousandseparator.fr

    Default value:

    de: Point

    en: Comma

    fr: Space

    Description:

    Notation examples:

    • thousand.seperator.en=.

    • thousand.seperator.fr=" "