Instance settings

Mapping repositories to instances

Repositories are mapped to instances. The tia Viewer Core allows each instance to be configured separately.

In SAP-side customized tia Viewer Core configuration, the mapping to an instance resides on SAP-side. For more information read about column Viewer Conf in https://kgs-software.atlassian.net/wiki/spaces/WIKI/pages/3257106464/SAP+Customizing+Vc#%2FKGS1%2FVIEWER_CUST-Transaction .
In Content Server Viewer (CSV) configuration, the mapping is specified in the tia Viewer configuration using parameter tia.repositoryinstancemapping, see also https://kgs-software.atlassian.net/wiki/x/B4C1wg.

tia Viewer Core maps repositories to instance default, if no explicit mapping exists.

Applying instance settings

Instance settings must reference a specific instance, so

when setting via environmental variable, the variable name must always contain following prefix

tia.instances.<instance name>.

when using a viewer YAML configuration file, the correct location is important (below the instance name and with two spaces more intend).

The instance default is the template for all instances: If a parameter is not specified for a specific instance, the setting of default is applied.

If also for instance default no setting was applied, tia Viewer uses built-in default values (global default).

The more specific setting overrules the the more general.

E.g., tia.instances.finance.documentNote overrules for instance finance the default

specified for the installation by tia.instances.default.documentNode for all instances

which overrules the global default value of true.

Configuration	Built-in Default	Description
`annotationFontColor`	`rgb(0,0,0)`	Default font color for annotations as RGB value.
`annotationFontSize`	`12`	Size of the font in annotations.
`annotationLineColor`	`rgb(0,0,0)`	Color of the line of a annotation as RGB value.
`annotationLineSize`	`5`	default size of the annotation lines
`annotationMouseoverTimeout`	`2000`	Defines the amount of time in milliseconds to display the information, who and when an annotation was created, until this notification timeouts.
`autoTurnOffEditMode`	`false`	Automatically turns of the Edit mode in case the document has been saved.
`checkmarkColor`	`rgb(0,0,0)`	default color of the checkmark
`checkmarkHeight`	`23`	default high of the checkmark annotation
`checkmarkLineSize`	`5`	Size of a checkmark line
`checkmarkWidth`	`36`	The default width of a checkmark
`docNoteFontSize`	`12`	Default font size for notes
`docNoteModalMinEditHeight`	`50`	Minimal allowed height of the edit note modal. User cannot make it smaller than this value
`docNoteModalMinHistHeight`	`150`	Minimal height of the history list in the note model edit view.
`docNoteModalMinWidth`	`300`	Minimal allowed high of the edit note modal. User cannot make it smaller than this value
`docNoteModalPrefEditHeight`	`150`	default high of the notes modal
`docNoteModalPrefHistHeight`	`300`	default height of the history list in the note model edit view
`docNoteModalPrefWidth`	`400`	Default width of the document notes modal dialog.
`docNoteModalResize`	`true`	when active a user can reside the notes modal
`documentNote`	`true`	When activated, the note button in the frontend is visible and can be used.
`documentNoteOpenMode`	`closed`	This option control the note area opening behavior when opening a document: closed - note area is always closed open if note available - note is opened on show document when a note exists always open - note area is always open
`downloadAnnotationsDefault`	`true`	Default value for the modal download dialog. When Activated the checkbox is prefilled, otherwise checkbox is not selected.
`downloadDocument`	`true`	If this option is activated, users can download documents.
`downloadDocumentNoteDefault`	`true`	Default value for the modal download dialog. When Activated the checkbox is prefilled, otherwise checkbox is not selected.
`drawArrow`	`true`	If this option is activated, users can draw arrows.
`drawCheckmark`	`true`	If this option is activated, users can draw checkmarks
`drawCircle`	`true`	If this option is activated, users can draw circles.
`drawFreehand`	`true`	If this option is activated, users can draw freehand lines.
`drawHighlight`	`true`	If this option is activated, users can draw highlights.
`drawLine`	`true`	If this option is activated, users can draw lines.
`drawRectangle`	`true`	If this option is activated, users can draw rectangles.
`drawRedaction`	`true`	If this option is activated, users can draw redactions.
`drawStamp`	`true`	If this option is activated, users can use stamps.
`drawSticky`	`true`	If this option is activated, users can draw sticky notes
`drawText`	`true`	If this option is activated, users can add text to documents.
`editMode`	`true`	When activated, new annotations can be edited (created).
`editOther`	`true`	Defines whether a user may edit annotations created by others or whether he may only edit annotations created by himself
`emailDocument`	`true`	If this option is activated, sending the document via email is enabled (only if OAuth is used).
`mail.view_mode`	`Popup`	Change the behavior of the Microsoft Graph Mail API. On “mail send” following will happen: on `Popup`: A new tab will open with Microsoft Office 365 Outlook Online displaying the draft mail only. on `Embedded`: A new tab will open with Microsoft Office 365 Outlook Online with user’s mail box.
`mimeTypes`	application/pdf, image/tiff, image/tif, image/jpeg, image/jp2, image/png	The viewer supports these types with instance `default` and convert the images to PDF.
`notificationTimeout`	`5000`	Defines the time span in milliseconds until a notification timeouts.
`openEditAtStart`	`false`	If this option is activated, edit mode is automatically entered when a document is opened.
`printAnnotations`	`true`	If this option is activated, users can print annotations.
`printAnnotationsDefault`	`true`	Default value for the modal print dialog. When Activated the checkbox is prefilled, otherwise checkbox is not selected.
`printDocument`	`true`	If this option is activated, users can print documents.
`printDocumentNote`	`true`	If this option is activated, users can print the document note.
`printDocumentNoteDefault`	`true`	Default value for the modal print dialog. When Activated the checkbox is prefilled, otherwise checkbox is not selected.
`sap.password`		Password for the SAP connection
`sap.url`		For saving or creating annotations a secKey is required and can be created by sap. <http\|https>://<Host:Port>/tia/tia_viewer?sap-client=<clientId>
`sap.username`		Username for the SAP connection
`securityDisabledForGetsWithUnsupportedMimeType`	`false`	unsupported MimeTypes like xlsx, docx do not require oauth login when set to false and configured https://kgs-software.atlassian.net/wiki/spaces/WIKI/pages/3254419471/Configuration+Vc#Global-OPENID-Configuration
`securityEnabled`	`false`	use security for oauth and mail, openid configuration required: https://kgs-software.atlassian.net/wiki/spaces/WIKI/pages/3254419471/Configuration+Vc#Global-OPENID-Configuration
`showAnnotationHistory`	`true`	When activated, the annotation history is accessable.
`showDocStructure`	`true`	If this option is activated, users can select the doc structure.
`showOleList`	`true`	show ole attachments when included
`showWatermark`	`true`	If this option is activated, a watermark is set.
`sidebarViewOnLoad`	`0`	If this option is activated (1), the thumbnail is automatically displayed when a document is opened.
`stampLocations`		Support Stamps in the following formats: JPEG PNG BMP GIF Configuration allows to enter a folder e.g.: file:///tmp/stamps/ one or more files: "file:///tmp/stamps/accept.png, /tmp/stamps_new/declined.jpg"
`viewerEnabled`	`true`	If active, a ArchiveLink get request for a component will return the viewer. This configuration allows to use the viewer without SAP Customizing (see https://kgs-software.atlassian.net/wiki/spaces/WIKI/pages/3246620679/Supported+Scenarios+Vc#tia-Viewer-CSV-Scenario* )
`watermark.text`		Text for the watermark in the background