Versions Compared

Old Version 13

changes.mady.by.user Armin Franke

Saved on

compared with

New Version 14

changes.mady.by.user Armin Franke

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Mapping repositories to instances

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

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

However, instance variables do not need to be specified in case default is accepted.

tia Viewer has built-in default values (global default), but also per installation default values for all instances can be configured by using default instead of the <instance name>.

Info

The more specific overrules the the more general setting.

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 built-in global default value of true.

Configuration

Built-in Default

Description

documentNote

true

When activated, the note button in the frontend is visible and can be used.

printDocumentNoteDefault

true

Default value for the modal print dialog. When Activated the checkbox is prefilled, otherwise checkbox is not selected.

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

docNoteModalResize

true

when active a user can reside the notes modal

docNoteModalPrefWidth

400

Default width of the document notes modal dialog.

docNoteModalPrefEditHeight

150

default high of the notes modal

printDocumentNote

true

If this option is activated, users can print the document note.

openEditAtStart

false

If this option is activated, edit mode is automatically entered when a document is opened.

docNoteFontSize

12

Default font size for notes

autoTurnOffEditMode

false

Automatically turns of the Edit mode in case the document has been saved.

annotationLineSize

5

default size of the annotation lines

checkmarkHeight

23

default high of the checkmark annotation

checkmarkColor

rgb(0,0,0)

default color of the checkmark

sidebarViewOnLoad

0

If this option is activated (1), the thumbnail is automatically displayed when a document is opened.

drawCheckmark

true

If this option is activated, users can draw checkmarks

downloadDocument

true

If this option is activated, users can download documents.

drawText

true

If this option is activated, users can add text to documents.

drawFreehand

true

If this option is activated, users can draw freehand lines.

showDocStructure

true

If this option is activated, users can select the doc structure.

editMode

true

When activated, new annotations can be edited (created).

checkmarkWidth

36

The default width of a checkmark

annotationMouseoverTimeout

2000

Defines the amount of time in milliseconds to display the information, who and when an annotation was created, until this notification timeouts.

drawHighlight

true

If this option is activated, users can draw highlights.

drawArrow

true

If this option is activated, users can draw arrows.

printAnnotationsDefault

true

Default value for the modal print dialog. When Activated the checkbox is prefilled, otherwise checkbox is not selected.

editOther

true

Defines whether a user may edit annotations created by others or whether he may only edit annotations created by himself

drawStamp

true

If this option is activated, users can use stamps.

notificationTimeout

5000

Defines the timespan in milliseconds until a notification timeouts.

showAnnotationHistory

true

When activated, the annotation history is accessable.

checkmarkLineSize

5

Size of a checkmark line

drawRedaction

true

If this option is activated, users can draw redactions.

annotationFontSize

12

Size of the font in annotations.

drawRectangle

true

If this option is activated, users can draw rectangles.

printAnnotations

true

If this option is activated, users can print annotations.

annotationLineColor

rgb(0,0,0)

Color of the line of a annotation as RGB value.

downloadAnnotationsDefault

true

Default value for the modal download dialog. When Activated the checkbox is prefilled, otherwise checkbox is not selected.

showOleList

true

show ole attachments when included

docNoteModalPrefHistHeight

300

default height of the history list in the note model edit view

emailDocument

true

If this option is activated, sending the document via email is enabled (only if oauth is used).

annotationFontColor

rgb(0,0,0)

Default font color for annotations as RGB value.

drawCircle

true

If this option is activated, users can draw circles.

showWatermark

true

If this option is activated, a watermark is set.

printDocument

true

If this option is activated, users can print documents.

drawLine

true

If this option is activated, users can draw lines.

docNoteModalMinEditHeight

50

Minimal allowed height of the edit note modal. User cannot make it smaller than this value

downloadDocumentNoteDefault

true

Default value for the modal download dialog. When Activated the checkbox is prefilled, otherwise checkbox is not selected.

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

drawSticky

true

If this option is activated, users can draw sticky notes

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

sap.password

Password for the SAP connection

watermark.text

Text for the watermark in the background

stamps.locations

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* )

mimeTypes

Code Block
"application/pdf",
"image/tiff",
"image/tif",
"image/jpeg",
"image/jp2",
"image/png"

The viewer supports these types in default an convert the images to pdf.

You reconfigure it and only use the viewer with pdfs with:
tia.instances.<instance>.mimetypes.0=application/pdf

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 a DeepLink to the Microsoft Office 365 Outlook Online Page. The Page will be added as attachment. The User only see the Draft of the Mail.

on  "Embedded":

  • A new Tab will open with a Link to the Microsoft Office 365 Outook Online Page. The Page will be added as attachment. The User can see this Inbox, Outbox and Drafts.

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

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