This section describes the SAP-side customization when using tia Viewer in SAP-side customized tia Viewer Core configuration. Among other settings, the mapping of repositories to tia Viewer URLs and its instances resides here.
Prerequisite is importing the SAP transport container. It is available in kgs Members Area in section tia® H5 Viewer.
Container transport number: E23K900055, tia H5 Viewer Version 3.0.0
Please note: SAP-User for KGS Components
Exit-Module, TOAEX SAP Table
Before executing kgs customizing, the exit module for document retrieval must be registered.
After registration, the exit module is executed each time a document is retrieved. If the module cannot recognize kgs customizing information that causes the tia Viewer to start, the SAP ArchiveLink default setting is used.
The following must be entered in the TOAEX standard table:
EXIT ID | S | Function module |
|---|---|---|
OA_OBJECTDISPLAY_01 | X | /KGS1/CALL_VIEWER |
(Transaction SE16n → Table TOAEX, Exit ID: OA_OBJECTDISPLAY_01)
/KGS1/VIEWER_CUST transaction
The transaction /KGS1/VIEWER_CUST grants access to client-specific adjustment by content repository on how the system calls the tia Viewer.
(Transaction /KGS1/VIEWER_CUST)
The table contains the following information:
Parameter | Description |
|---|---|
Cont. Rep. | Content Repository ID |
HTTP server | Host name or IP address of the web server on which the tia Viewer is hosted. |
Port | Port number for accessing the web server. |
HTTP Script | Web context of the tia Viewer. |
Viewer Conf | Name of the tia Viewer instance to be used for this repository. Instance |
active/inactive | Customizing activated/deactivated. |
https | Activate or deactivate SSL communication with tia Viewer. |
Activate or deactivate tia Viewer for displaying PDF documents. | |
TIF | Activate or deactivate tia ViewerI for displaying TIF documents. |
JPG | Activate or deactivate tia Viewer for displaying JPG documents. |
MimeType | If activated, the system performs an INFO request first to determine the MIME type before displaying the document. Activation increases the load on the archive server, while ignoring the MIME type specification in ArchiveLink information. Default is deactivated. |
CompID | If activated, the system performs an INFO request to determine the component id before displaying the document, instead of defaulting to component id |
/KGS1/VIEWER_DOCTY transaction
The transaction /KGS1/VIEWER_DOCTY, grants access to client-specific adjustment by business object and document type on how the system calls the tia Viewer.
Customizing it is optional, and can be done in combination with customizing via /KGS1/VIEWER_CUST transaction.
/KGS1/VIEWER_PARAM transaction / secret token
Use the transaction /KGS1/VIEWER_PARAM for following configurations:
Storing the token password
Defining, whether the call of the tia Viewer shall check an authorization object
To define the installation path / paths to browsers
The following entries are possible:
ID | Parameter | Description |
|---|---|---|
01 | Token Password | Type: String The password must match the setting in tia Viewer side configuration. See parameter |
02 | Check Viewer Authorization | Type: Boolean If activated, the authorization object is checked user and group access rights. These access rights are combinations of |
03 | Browser Path Chrome | Type: String Here you may define the path pointing to the installed exe-file of the Chrome browser |
04 | Browser Path Firefox | Type: String Here you may define the path pointing to the installed exe-file of the Firefox browser |
05 | Browser Path IE | Type: String Here you may define the path pointing to the installed exe-file of the Internet Explorer |
06 | Browser Path Edge | Type: String Here you may define the path pointing to the installed exe-file of the Edge browser |
07 | Browser Path Other | Type: String Here you may define the path pointing to the installed exe-file of any other browser |
(Transaction /KGS1/VIEWER_PARAM )
After defining a path or many paths to the installation-directory / -ies of the browser / browsers you may define for a user or group the browser that will be used.
User profile with definition of default browser "Mozilla Firefox" |
|---|
 |
/KGS1/SUPRESS_VIEWER user parameter
By SAP user parameter /KGS1/SUPRESS_VIEWER, the user can deactivate tia Viewer. This parameter can be set using transaction SU3.
BAdi /KGS1/VIEWER_WINDOW_NAME
The enhancement spot /KGS1/VIEWER_WINDOW_NAME allows to overwrite the default name for the window title and file download.
The default name is (<AR_OBJECT> specifies the document type, and <OBJECT_ID> the object id of SAP ArchiveLink):
<AR_OBJECT> <OBJECT_ID>
The tia Viewer replaces all (space) by - (hyphen) from the window title and uses this as download name. All other characters stay unchanged.
All characters in file names must be allowed in the file system used.
E.g. invalid characters for Windows filenames are:
< (less than)
> (greater than)
: (colon)
" (double quote)
/ (forward slash)
\ (backslash)
| (vertical bar or pipe)
? (question mark)
* (asterisk)
If the tia® Content Server (core) is used, the following parameter must be set in the repository.cfg file, so that window name is displayed correctly.
<repository>.saphttp.disablecontentdisposition = true
Badi implementation guide by SAP: https://help.sap.com/viewer/6f40b8f46c4b10149770d29604c9a4eb/7.01.22/en-US/44f518d884056c30e10000000a114a6b.html
Web service for tia Viewer
For the new version of the tia Viewer a web service is needed. This web service is included in the above mentioned transport.
To activate the web service change to transaction SICF and press the “Execute” button.
In the next window you will find the webservice tia_viewer under the tab tia.
Right click on the web service tia_viewer and press “Activate Service”
Choose the button “Yes”.
The web service is activated and should be accessible via the URL of your SAP-System
https://<sap-system>:<port>/tia/tia_viewer
Now the web service can be tested. Right click on the web service and choose “Test Service”
The browser will open and will show the following result.
https://<sap-system>:<port>/tia/tia_viewer?sap-client=<client>
Via the URL https://<sap-system>:<port>/tia/tia_viewer?sap-client=<client> and additional parameters attached in the body to the POST request
The URL to call the document out of the archive with the corresponding seckey is returned:
https://<archive-server>:<port>/contentserver?create&pVersion=<AL-Version>&contRep=<CR>&docId=<Doc-ID> &compId=<comp_id>&accessMode=c&authId=<SAP-Cerificate>&expiration=<expiration_time>&secKey=<secKey>
e.g.
This URL is included into the new tia Viewer to display the archived document.