SAP Customizing allows you to control which KGS Viewer profile will be used. After successfully importing the SAP transport container that is available in our Members Area in section tia® H5 Viewer, you can call KGS-specific Customizing.
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 KGS Viewer to start, the SAP ArchiveLink default setting3 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
With transaction /KGS1/VIEWER_CUST, you can access an area in which the client-specific adjustment is defined for how the system is to call the KGS Viewer based on the content repository.
Please note: After installing the newest version of the viewer pack, the changes won't have to be transported anymore, but will instead be set without a transportation.
(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 webserver on which the Viewer servlet is hosted. |
Port | Port number for accessing the webserver. |
HTTP Script | Script to call the servlet. |
Config | Name of the Viewer Instance to be used for this Repository. Default Profile will be used if empty. |
active/inactive | Customizing activated/deactivated. |
https | SSL communication with the webserver activated/deactivated. |
Usage of the viewer for PDF documents activated or deactivated. | |
TIF | Usage of the viewer for TIF documents activated or deactivated. |
JPG | Usage of the viewer for JPG documents activated or deactivated. |
MimeType | This option can be used if the document type for ArchiveLink connections is not correct. If activated, the system performs an INFO request to determine the MIME type before displaying the document. This will increase the load on the archive server. Normally, this option is not required. |
CompID | This option can be used if the documents Component Id is not data, which is the default. If activated, the system performs an INFO request to determine the Component Id before displaying the document. This will increase the load on the archive server. Normally, this option is not required. |
/KGS1/VIEWER_DOCTY Transaction
With transaction /KGS1/VIEWER_DOCTY, you can access an area in which the client-specific adjustment is defined for how the system is to call the KGS Viewer based on business object plus document type.
This Customizing is optional. If no settings have been made for specific business object plus document types, you can simply perform standard content repository-specific customizing. Of course, you can also combine the two customizing methods.
/KGS1/VIEWER_PARAM Transaction / secret token
The Transaction /KGS1/VIEWER_PARAM may be used for the following purposes:
Storing the secret
Defining, whether the call of the H5 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 You may enter the token password here in order to store it |
02 | Check Viewer Authorization | Type: Boolean You may set this to true, in order to check the authorization object, which might define special access rights for a user or group following the crud principle. |
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
If a user does not want to use the KGS Viewer, the user can be deactivated using the SAP user parameter[1] /KGS1/SUPRESS_VIEWER.
[1] Can be set by the user using transaction SU3.
BAdi /KGS1/VIEWER_WINDOW_NAME
Available from KGS Viewer Pack 2.4
The enhancement spot /KGS1/VIEWER_WINDOW_NAME allows to overwrite the default name for the window titel and file download. KGS provides only a fallback implementation that uses <AR_OBJECT> (Document Type) <OBJECT_ID> (SAP ArchiveLink: Object Id) as name.
The viewer itself will replace all " " (space) with "-" (hyphen) from the window title and uses this as download name. All other characters are not changed. Please make sure that no characters is in the filename, that is not allowed by the filesystem:
If the tia® Content Server (core) is used, the following parameter must be set in the repository.cfg so that window name is displayed correctly.
<repo>.saphttp.disablecontentdisposition = true
Invalid characters for Windows filenames
< (less than)
> (greater than)
: (colon)
" (double quote)
/ (forward slash)
\ (backslash)
| (vertical bar or pipe)
? (question mark)
(asterisk)
Badi implementation guide by SAP: https://help.sap.com/viewer/6f40b8f46c4b10149770d29604c9a4eb/7.01.22/en-US/44f518d884056c30e10000000a114a6b.html
Websevice for tia H5 Viewer
For the new version of the tia H5 Viewer a webservice is needed. This webservice is included in the above mentioned transport.
To activate the webservice 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 webservice tia_viewer and press “Activate Service”
Choose the button “Yes”.
The webservice is activated and should be accessible via the URL of your SAP-System
https://<sap-system>:<port>/tia/tia_viewer
e.g. https://e23.kgs.team:50000/tia/tia_viewer
The webservice can be testet. Right click on the webservice and choose “Test Service”
The browser will open and will show the following result.
https://<sap-system>:<port>/tia/tia_viewer?sap-client=<client>
e.g. https://e23.kgs.team:50000/tia/tia_viewer?sap-client=800
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 H5 Viewer to display the archived document.