The configuration can be done by environment variables or by a yaml configuration file. For more complex scenario the yaml is recommended.
Global Environment Variables
...
Configuration
...
Required
...
Default
...
Description
...
tia.destinations.saphttp.host
...
...
Hostname of the server with the ContentServer
...
tia.destinations.saphttp.port
...
...
Port of the ContentServer usually 80 or 443
...
tia.destinations.saphttp.protocol
...
https
...
Protocol of the contentserver http or https
...
tia.destinations.saphttp.path
...
/contentserver
...
Context Path of the server usually /contentserver
...
tia.overlay.isNoteEnabled
...
false
...
Default setting when the request for print does not contain any information whether to include the notes or not.
...
tia.overlay.isAnnotationEnabled
...
false
...
Default setting when the request for print does not contain any information whether to include the annotations or not.
...
tia.secKey
...
ABC123
...
This default is not intended for production use, please change this value
...
tia.stamps.locations
...
Default stamps available to all instances, additional to the instance specific configured values.
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"
...
tia.stamps.cacheSize
...
100
...
Max size of cache entries, i.e. one stamp file is one entry. If more stamps are present, the oldest ones are removed from cache.
...
tia.stamps.expireMinutes
...
10
...
Lifetime of unused entries in stamp cache in minutes.
...
tia.stamps.maxFileSize
...
10000000
...
Max filesize in bytes of each stamp file.
...
tia.mail.view_mode
...
Popup
...
When sending mail, how the compose window should be displayed, Default is Popup, i.e. a new window/tab is opened.
Available values: Popup, Embedded
Global OPENID Configuration
...
Configuration
...
Required
...
Description
...
spring.security.oauth2.client.provider.tia.issuer-uri
...
...
Usually https://login.microsoftonline.com/<tenant>/v2.0
...
spring.security.oauth2.client.provider.tia.user-name-attribute
...
...
Defines where in the token the username can be found that will be used in the notes, usually name
...
spring.security.oauth2.client.registration.tiaviewer.provider
...
...
The provider that should be used. Should be tia
...
spring.security.oauth2.client.registration.tiaviewer.client-id
...
...
The public identification of the application, the ClientId
...
spring.security.oauth2.client.registration.tiaviewer.client-secret
...
...
The client secret for the application
...
spring.security.oauth2.client.registration.tiaviewer.scope[0]
...
...
fixed value openid
...
spring.security.oauth2.client.registration.tiaviewer.scope[1]
...
...
fixed value email
...
spring.security.oauth2.client.registration.tiaviewer.scope[2]
...
...
fixed value profile
...
tia.security.oidc.type
...
...
authorization_code
Instance Variables
All instance variables are optional and there is no configuration required. Use the default profile in this case. You can also override the default profile with your own configuration or create new instances. Only changed parameter should be in the configuration.
configurations are overritten in there levels:
global default
default instance configuration
specific instance configuration
Example:
Global inbuild default: documentNote is true. (notes can be created in documents.
default configuration override: tia.instances.default.documentNote is false. Inbuild default is overwritten and notes are global disabled
Finance configuration allows notes: tia.instances.finance.documentNote is true. When the instance finance is used the notes can be applied and displayed.
...
Configuration
...
Default
...
Description
...
tia.instances.<instance>.documentNote
...
true
...
When activated, the note button in the frontend is visible and can be used.
...
tia.instances.<instance>.printDocumentNoteDefault
...
true
...
Default value for the modal print dialog. When Activated the checkbox is prefilled, otherwise checkbox is not selected.
...
tia.instances.<instance>.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
...
tia.instances.<instance>.docNoteModalResize
...
true
...
when active a user can reside the notes modal
...
tia.instances.<instance>.docNoteModalPrefWidth
...
400
...
Default width of the document notes modal dialog.
...
tia.instances.<instance>.docNoteModalPrefEditHeight
...
150
...
default high of the notes modal
...
tia.instances.<instance>.printDocumentNote
...
true
...
If this option is activated, users can print the document note.
...
tia.instances.<instance>.openEditAtStart
...
false
...
If this option is activated, edit mode is automatically entered when a document is opened.
...
tia.instances.<instance>.docNoteFontSize
...
12
...
Default font size for notes
...
tia.instances.<instance>.autoTurnOffEditMode
...
false
...
Automatically turns of the Edit mode in case the document has been saved.
...
tia.instances.<instance>.annotationLineSize
...
5
...
default size of the annotation lines
...
tia.instances.<instance>.checkmarkHeight
...
23
...
default high of the checkmark annotation
...
tia.instances.<instance>.checkmarkColor
...
rgb(0,0,0)
...
default color of the checkmark
...
tia.instances.<instance>.sidebarViewOnLoad
...
0
...
If this option is activated (1), the thumbnail is automatically displayed when a document is opened.
...
tia.instances.<instance>.drawCheckmark
...
true
...
If this option is activated, users can draw checkmarks
...
tia.instances.<instance>.downloadDocument
...
true
...
If this option is activated, users can download documents.
...
tia.instances.<instance>.drawText
...
true
...
If this option is activated, users can add text to documents.
...
tia.instances.<instance>.drawFreehand
...
true
...
If this option is activated, users can draw freehand lines.
...
tia.instances.<instance>.showDocStructure
...
true
...
If this option is activated, users can select the doc structure.
...
tia.instances.<instance>.editMode
...
true
...
When activated, new annotations can be edited (created).
...
tia.instances.<instance>.checkmarkWidth
...
36
...
The default width of a checkmark
...
tia.instances.<instance>.annotationMouseoverTimeout
...
2000
...
Defines the amount of time in milliseconds to display the information, who and when an annotation was created, until this notification timeouts.
...
tia.instances.<instance>.drawHighlight
...
true
...
If this option is activated, users can draw highlights.
...
tia.instances.<instance>.drawArrow
...
true
...
If this option is activated, users can draw arrows.
...
tia.instances.<instance>.printAnnotationsDefault
...
true
...
Default value for the modal print dialog. When Activated the checkbox is prefilled, otherwise checkbox is not selected.
...
tia.instances.<instance>.editOther
...
true
...
Defines whether a user may edit annotations created by others or whether he may only edit annotations created by himself
...
tia.instances.<instance>.drawStamp
...
true
...
If this option is activated, users can use stamps.
...
tia.instances.<instance>.notificationTimeout
...
5000
...
Defines the timespan in milliseconds until a notification timeouts.
...
tia.instances.<instance>.showAnnotationHistory
...
true
...
When activated, the annotation history is accessable.
...
tia.instances.<instance>.checkmarkLineSize
...
5
...
Size of a checkmark line
...
tia.instances.<instance>.drawRedaction
...
true
...
If this option is activated, users can draw redactions.
...
tia.instances.<instance>.annotationFontSize
...
12
...
Size of the font in annotations.
...
tia.instances.<instance>.drawRectangle
...
true
...
If this option is activated, users can draw rectangles.
...
tia.instances.<instance>.printAnnotations
...
true
...
If this option is activated, users can print annotations.
...
tia.instances.<instance>.annotationLineColor
...
rgb(0,0,0)
...
Color of the line of a annotation as RGB value.
...
tia.instances.<instance>.downloadAnnotationsDefault
...
true
...
Default value for the modal download dialog. When Activated the checkbox is prefilled, otherwise checkbox is not selected.
...
tia.instances.<instance>.showOleList
...
true
...
show ole attachments when included
...
tia.instances.<instance>.docNoteModalPrefHistHeight
...
300
...
default height of the history list in the note model edit view
...
tia.instances.<instance>.emailDocument
...
true
...
If this option is activated, sending the document via email is enabled (only if oauth is used).
...
tia.instances.<instance>.annotationFontColor
...
rgb(0,0,0)
...
Default font color for annotations as RGB value.
...
tia.instances.<instance>.drawCircle
...
true
...
If this option is activated, users can draw circles.
...
tia.instances.<instance>.showWatermark
...
true
...
If this option is activated, a watermark is set.
...
tia.instances.<instance>.printDocument
...
true
...
If this option is activated, users can print documents.
...
tia.instances.<instance>.drawLine
...
true
...
If this option is activated, users can draw lines.
...
tia.instances.<instance>.docNoteModalMinEditHeight
...
50
...
Minimal allowed height of the edit note modal. User cannot make it smaller than this value
...
tia.instances.<instance>.downloadDocumentNoteDefault
...
true
...
Default value for the modal download dialog. When Activated the checkbox is prefilled, otherwise checkbox is not selected.
...
tia.instances.<instance>.docNoteModalMinHistHeight
...
150
...
Minimal height of the history list in the note model edit view.
...
tia.instances.<instance>.docNoteModalMinWidth
...
300
...
Minimal allowed high of the edit note modal. User cannot make it smaller than this value
...
tia.instances.<instance>.drawSticky
...
true
...
If this option is activated, users can draw sticky notes
...
tia.instances.<instance>.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>
...
tia.instances.<instance>.sap.username
...
Username for the SAP connection
...
tia.instances.<instance>.sap.password
...
Password for the SAP connection
...
tia.instances.<instance>.watermark.text
...
Text for the watermark in the background
...
tia.instances.<instance>.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"
...
tia.instances.<instance>.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* )
...
tia.instances.<instance>.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
...
tia.instances.<instance>.mail.view_mode
...
Popup
...
Change the behaviour 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.
How to configure
The viewer allows two different ways to apply configuration.
Configuration by environment variables is for configurations that are small and modify only a few variables. It is easy and fast to create and apply these configurations.
Configuration with yaml is for more complex configurations and different instances with complete different configurations. A yaml is prepared and then mapped in the container like as configmap or volume mapping.
Configuration by environment variables
Example for docker compose file
| Code Block | ||
|---|---|---|
| ||
version: '3'
services:
tiaviewer:
container_name: tiaviewer
image: images.docker.kgs-cloud.de/tia-viewer/archivelink-oidc:latest
ports:
- "8080:8080"
environment:
tia.destinations.saphttp.host: contentservevr.kgs.local
tia.destinations.saphttp.port: 8090
tia.instances.default.watermark.text: copy
tia.instances.default.sap.url: https://sapServer:8400/tia/tia_viewer?sap-client=250
tia.instances.default.sap.username: secuser
tia.instances.default.sap.password: s3cret
tia.instances.default.mimetypes.0: application/pdf |
Configuration with yaml
Example for docker compose file
viewer.yaml:
| Code Block | ||
|---|---|---|
| ||
tia:
destinations:
saphttp:
host: contentservevr.kgs.local
port: 8090
instances:
default:
watermark:
text: "copy"
sap:
url: "https://sapServer:8400/tia/tia_viewer?sap-client=250"
username: secuser
password: s3cret
mimetypes:
- application/pdf
HR:
downloadDocument: false
FI:
text: "confidential"
FO:
printDocumentNote: false
mimetypes.0: application/pdf |
load the viewer.yaml in the container:
...
| language | yaml |
|---|
...
tia® Viewer Core is configured using configuration parameters. There are different ways to specify them, described here: https://kgs-software.atlassian.net/wiki/x/FAALxw .
There are two categories of configuration parameters:
Global settings apply to the tia® Viewer Core instance, and
Instance settings apply to named instances, so configurations can be mapped to repositories, respectively to business objects and document types (SAP Customizing only, see Customize by repository respective business object and document type).