Page Comparison

Token Secret

String

The token secret is a password that is used to decrypt an encrypted the URL token (contained in the URL when called via SAP). The token cannot be validated without the password. The token is then secured against manipulation. On the SAP side, the token is generated using the same password. There is therefore also a Customizing in SAP in which the password must be stored. The tia® H5 Viewer can only be used if both sides know the same password.

External authentication method

Checkbox

If this option is enabled, an external authentication mode like OIDC or Keycloak should be used.

See :

tia® H5 Viewer Authentication via Microsoft OpenID Connect (OIDC) and Register Microsoft Azure application for email delivery

or 

/wiki/spaces/WIKI/pages/2203779077

Deactivated / false

Authenticated actions

Dropdown

If an extenal authentication method is used, the Administrator can choose wether the authentication should be triggered whenever the document is displayed [All actions ] or only when an Email should be sent Only send Mail

Possible Selections:

• None

• All actions

• Only send mail

All actions

realm

String

The realm which is configured in Keycloak to use

master

resource

String

The Client which belongs to the configured realm.

auth-server-url

String

The URL to the Keycloak Endpoint. 

E.g. https://my-server:9005/auth

principal-attribute

String

The OpenIDConnect tokenattribute to fill the User-Information. This is used for annotation history. Allowed Values are:

• sub

• preffered_username

• email

• name

• nickname

• given_name

• family_name

preferred_username

ssl-required

String

Ensure the communication is HTTPS protected. In Production this should set to "all". Allowed Values are:

• all 

  • Keycloak requires SSL for all IP addresses

• external

  • User can interact with Keycloak so long as they stick to private IP addresses like "localhost", "10.0.x.x", "192.168.x.x" or "172.16.x.x". 

• none

  • Keycloak requires SSL for all IP addresses

use-resource-role-mappings

Checkbox

If set to true, the adapter will look inside the token for application level role mappings for the user. If false, it will look at the realm level for user role mappings. This is OPTIONAL. The default value is true.

true

credentials.secret

String

The Keycloak credential to Login from KGS Viewer Backend to the Keycloak-Instance

identityProviderAlias

String

The Alias of the IdentityProvider, which is configured in the Keycloak realm

logoutRedirectUrl

String

(Optional) The address where the User is redirected after a successful logout

Render Annotations

Checkbox / boolean

When activated, any annotations are displayed/rendered.

Activated / true

Annotation History

Checkbox / boolean

When activated, the annotation history is accessable.

Activated / true

Edit Mode

Checkbox / boolean

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

Activated / true

Document Note

Checkbox / boolean

When activated, the data is transferred from a note.ixos component to the standard note component at runtime.

Activated / true

Download Document

Checkbox / boolean

If this option is activated, users can download documents.

Activated / true

Print Document

Checkbox / boolean

If this option is activated, users can print documents. When printing, you decide whether notes and SAP notes are included in the printout.

Activated / true

Document Note Open Mode

Selection

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

Print Annotations

Checkbox / boolean

If this option is activated, users can print annotations.

Activated / true

Print Annotations Default Value

Checkbox / boolean

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

Activated / true

Download Annotations Default Value

Checkbox / boolean

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

Activated / true

Print Document Note

Checkbox / boolean

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

Activated / true

Print Document Note Default Value

Checkbox / boolean

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

Activated / true

Print Document Note Default Value

Checkbox / boolean

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

Activated / true

Checkbox / boolean

If this option is activated, a watermark is set.

Activated / true

Watermark Text

String

The text of the watermark

Copy

Auto Open Thumbnails

Checkbox / boolean

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

Deactivated / false

Sticky Note Annotation

Checkbox / boolean

If this option is activated, users can draw sticky notes

Activated / true

Freehand Annotation

Checkbox / boolean

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

Activated / true

Rectangle Annotation

Checkbox / boolean

If this option is activated, users can draw rectangles.

Activated / true

Highlight Annotation

Checkbox / boolean

If this option is activated, users can draw highlights.

Activated / true

Redaction Annotation

Checkbox / boolean

If this option is activated, users can draw redactions.

Activated / true

Circle Annotation

Checkbox / boolean

If this option is activated, users can draw circles.

Activated / true

Line Annotation

Checkbox / boolean

If this option is activated, users can draw lines.

Activated / true

Stamp Annotation

Checkbox / boolean

If this option is activated, users can use stamps.

Activated / true

Text Annotation

Checkbox / boolean

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

Activated / true

Sync note.ixos

Checkbox / boolean

When this option is enabled, text-based document notes are transfered from the note.ixos component (created by the OpenText Viewer) to the note component.

Activated / true

Sync anno.ixos

Checkbox / boolean

If this option is activated, text-based annotations are transferred from the anno.ixos component (created by the OpenText Viewer) to the kgsannotation component. Texts migrated in this way are displayed as yellow notes in the KGS Viewer and cannot be changed.

Activated / true

Prevent Copy Url

Checkbox / boolean

If this option is activated, it is prevent to use a copied url.

Deactivated/false

Notification Timeout (sec)

Int

Defines the timespan until a notification timeouts.

5

Auto Turn Off Edit Mode

Checkbox/boolean

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

Deactivated/false

Edit Permission Other User

Checkbox/ boolean

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

Activated/true

Annotation Mouseover Timeout

Int

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

2

Note Encoding Detection Hint

String

Defines a hint for the note encoding detection. This is only used when no explicit encoding is saved along with the note.

The hint only helps to decide when the entered encoding is already recognized along with others and it is unclear what the correct encoding is.

Examples:

• ISO-8859-1

• UTF-8

• ISO-8859-2

• EBCDIC_500

• IBM866

• ...

-

Open edit mode at startup

Checkbox / boolean

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

Deactivated / false

2.5.7

Email Document (if external authentication is used)

Checkbox / boolean

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

Activated / true

2.5.10

Gateway Profile

Dropdown-list

A List of existing KGS DocGateway profiles

None