Configuration variants
Configuration via WebUI
Please refer to this article, for an instruction to access the WebGUI: Using the KGS Application Framework Web Console (WebGUI)
The KGS Application Framework Web Console provides configuration of basic settings, including working directory, debug level, and so on. The KGS Viewer Bundle configuration can be accessed from the menu Main → ContentServer4ArchiveLink.
Now click on Edit Configuration under Administration. Save the configuration changes with 
.
Edit Configuration
(Main → ContentServer4ArchiveLink, Edit Configuration)
Configuration using configuration files (.cfg)
For general information about the .cfg file handling please refer to this article: KGS application configuration files (.cfg)
The revelant .cfg files for the ContentServer are inside the contentserver subfolder.
Main configuration
The file ContentServer.cfg contains the parameters for the main configuration.
Repository configuration
Files like CS-Repositories.example.cfg contain the Repository specific configuration. (Here for the Repository "example")
To create a Repository .cfg file either use the Add Repository button or use the file CS-Repositories.example.cfg from the conf examples folder inside your product download.
Main Configuration parameters
License
Parameter Name | DataType | Description | Default |
|---|---|---|---|
License Key | String | KGS license key. Necessary for running the KGS CS. | |
IndexLicenseKey | String | Optional license key for the activation of the SAP IndexExport function. | |
ILMLicenseKey | String | Optional license key for the activation of the SAP ILM function. |
Barcode
Parameter Name | DataType | Description | Default |
|---|---|---|---|
Enable Barcode | Checkbox | Activation of the SAP ArchiveLink barcode function. | Inactive |
Protocol
Parameter Name | DataType | Description | Default |
|---|---|---|---|
Enable Protcol | Checkbox | Enable logging using the KGS ProtocolWriter. | Inactive |
Enable Component Info | Checkbox | Enable logging of Component Info request. | Inactive |
Protocol Alias | String | Alias of the KGS CS instance in the KGS ProtocolWriter. | |
serverInfo | Checkbox | Enable logging of serverInfo requests. | Inactive |
info | Checkbox | Enable logging info requests. | Inactive |
get | Checkbox | Enable logging of get requests. | Inactive |
create | Checkbox | Enable logging of create requests. | Inactive |
docGet | Checkbox | Enable logging of docGet requests. | Inactive |
mCreate | Checkbox | Enable logging of mCreate requests. | Inactive |
append | Checkbox | Enable logging of append requests. | Inactive |
delete | Checkbox | Enable logging of delete requests. | Inactive |
lock | Checkbox | Enable logging of lock requests. | Inactive |
update | Checkbox | Enable logging of update requests. | Inactive |
putCert | Checkbox | Enable logging of putCert requests. | Inactive |
search | Checkbox | Enable logging of search requests. | Inactive |
adminContrep | Checkbox | Enable logging of adminContrep requests. | Inactive |
attrSearch | Checkbox | Enable logging of attrSearch requests. | Inactive |
Common
Parameter Name | DataType | Description | Default |
|---|---|---|---|
Config File | String | File name of the KGS CS configuration file. Only used for legacy parameters. | Contentserver-conf.txt |
Config Directory | String | Directory of the previously specified configuration file. | <servlet_home>\conf\contentserver |
Working Directory | String | Work directory for temporary data files. | <servlet_home>\work\contentserver |
Debug | Int | Log Level 0 / 1: Only errors 2: Errors and warnings 3: Errors, warnings and info 4: All, including debug | 4 |
Max Process Count | Int | Number of maxiumum permitted object instances. Used for connections to the DMS via LinkOpen events. 0: No limitation | 0 |
Disable Delete Commands | Checkbox | Delete requests will not be processed/rejected by the KGS CS. | Inactive |
Force Component Return | Checkbox | When this parameter is activated, a component will always be delivered when processing a GET-request that does not specify a component ID, even if there is no data or data1 component to the document. The to be delivered components are determined by an exclusion procedure. The following components will not be delivered:
| Inactive |
Backend Read Timeout (s) | Int | Timeout in seconds until a read access to the DMS is terminated (thread interrupt). | 0 |
Backend Write Timeout (s) | Int | Timeout in seconds until a write access to the DMS is terminated (thread interrupt). | 0 |
SAPMimeExtentionLookup | Checkbox | When activated, the MimeType and the document type are determined and saved in SAP according to the customizing of document types (transaction 0AD2, table TOADD). | Inactive |
Min Process Count | Int | Number of lowest permitted object instances. A value greater then 0 will prevent the close of the last connection to the DMS. 0: no limitation | 0 |
Support MTA Documents | Checkbox | When activated, MTA documents are supported. (Special handling for DocIDs with a "MTA" in it) | Inactive |
RFC
The RFC tab contains the required parameters for the SAP-RFC communication (using the Barcode and IndexExport functions). The connection parameters can also be defined Content Repository specific.
Parameter Name | DataType | Description | Default |
|---|---|---|---|
RFC connection | Dropdown | Select the RFC connection configured in the KGS SAP Connector |
For older versions
Security
Parameter Name | DataType | Description | Default |
|---|---|---|---|
Default Security | Int | Default setting for Content-Repositories. 0: Security inactive 1: Security active & certificates are automatically activated after a putCert-Request. 2: Security active & certificates aren't automatically activated after a putCert-Request. The certificate must be activated with the CSAdmin in the transaction OAC0. This parameter can be defined Content-Repository specific. | |
Initial Certificate Store Password | String | Initial KeyStore password. Should not be changed after deployment. | |
SecurityChangeOnCommand | CSV list of ArchiveLink requests (non-case sensitive), e.g. create, delete, update, etc. When a request that is maintained in this list arrives, the value set in the Secutity parameter is inverted to process this request. Example 1: Security=2 → the SecKey procedure is acive. SecurityChangeOnCommand=get,delete,info The incoming GET request is processed WITHOUT checking the SecKeys incl. Expiration. Example 2: Security=0 → the SecKey procedure is not active. SecurityChangeOnCommand=get,delete,info The incoming GET request is processed WITH examination of the SecKeys incl. Expiration. This parameter can be defined Content-Repository specific. | ||
Allowed Clients | Only the clients specified here (IPs or hostnames) may write to the archive (create, update etc.). If no client is specified, all clients may write. The parameter is to be created as a CSV list. If a client is not listed, they receive the RC 401 → unauthorized. This parameter can be defined Content-Repository specific. | ||
Allowed CSAdmin Clients | Only the IP addresses or hostnames specified here (SAP server) are authorized to use the CSAdmin function in SAP. Requests from other IPs or hosts receive the RC 401 → unauthorized. This parameter is to be created as a CSV list. The last IP segment can be used a wildcard. For example; ContentServer.AllowedCSAdmin=sapadm,192.168.1.2,192.168.2.* This parameter can be defined Content-Repository specific. | ||
Default Document Protection | String | Default value for the DocProtection variable, if it does not exist in the http request. Usually this is part of the SAP http request. r: read u: update c: create d: delete | rucd |
Keystore Path | String | Path to the used KeyStore. Leave empty for default. | <servlet>/conf/contentserver/security |
Components
Parameter Name | DataType | Description | Default |
|---|---|---|---|
Sign and Verify Content | Checkbox | Creates a hash value and signs this with a timestamp. When the data is called, the hash value is verified against the signature. This parameter can be defined Content-Repository specific. | Inactive |
Hidden Components (info,docGet) | String | The components defined here are not returned when calling the info and docGet commands. | |
SecurityProvider | Dropdown list | Currently only timestamp signatures with certificate are available. This parameter can be defined Content-Repository specific. | TrustedTimestamp with Certificate |
Compression Mime Types | String | CSV list of MimeTypes that should be compressed. If this parameter is not defined, the compression will be applied to all MimeTypes (=*). For example; CompressMimeType=application/pdf,image/tiff Apart from MimeTypes, document types can also be defined, if the SAPMimeExtentionLookup parameter was configured. The MimeType for the document category is then determined by RFC using the SAP table TOADD. This parameter can be defined Content-Repository specific. | |
Compression Size (Mb) | Double | Defines that components equal or greater than the value specified here (in MB) should be compressed. This function is only supported if the DMS supports the “DMS_COMP_PROPERTY_COMPRESSI ONSTRING” property. For example: 1 → 1 MB 0.0488 → 50KB 0.1953 → 200KB 12.5 → 12.5MB 0.6835 → 700KB 0.0009765 → 1KB This parameter can be defined Content-Repository specific. | 0.0 |
Convert Single to Multipage Tiff | Checkbox | If enabled, during runtime, single page-tiffs (data1, data2, etc. components) are converted to multipage tiff format for display. The document in the archive will not be changed. This parameter can be defined Content-Repository specific. | Inactive |
Auto Decompress | Checkbox | When activated, the components are automatically decompressed. | Inactive |
Backend
Parameter Name | DataType | Description | Default |
|---|---|---|---|
Check Backend Mode | Dropdown list | If activated, when processing the serverInfo request, access to a random DocId for each Content-Repository is checked. This parameter can be defined Content-Repository specific. CAUTION: Only use this for troubleshooting! | Off |
DMS Connection Keep Alive | Checkbox | Controls whether a DMS connection (object instance) should be closed (LinkClose) when a DMS exception occurs. Active: DMS connection is terminated (LinkClose) and then reopened (LinkOpen). Useful if DMS does not support the reconnect. Inactive: Do not end the DMS connection | Active |
Timeout Requiring DMS Object (ms) | Int | If an instance of a DMS object no longer responds and new instances can no longer created because the limit has been reached from the Max Process Count parameter, then the time set here is waited (in seconds) until the suspended instance terminates and a waiting request is processed. 0: Timeout is deactivated |
Content
Parameter Name | DataType | Description | Default |
|---|---|---|---|
Exclude components from signing | String | Excludes individual components from signing. This parameter can be defined Content-Repository specific. Depends on the Sign and Verify Content settings in the Components section. | note;kgsannotation;descr;pagelist |
Index Export
Parameter Name | DataType | Description | Default |
|---|---|---|---|
Remote Function | String | Name of the SAP function module for processing the KeyExport function. | Z_KGSKEYEXPORT |
BarcodeTimer | Int (seconds) | Parameter for activating the barcode upload from the DMS to SAP. The processing directory is located within the working directory: <WorkingDirectory>/Barcode/ For the communication via RFC, the necessary parameters must be maintained. IMPORTANT: Furthermore, this timer also activates and controls the processing interval for the KeyExport function! | 0 |
ILM
Parameter Name | DataType | Description | Default |
|---|---|---|---|
ILM Repository | String | Name of a ILM „repository“ for the logical communication of data per the KGS CS interface. | |
ILM User | String | User from the SAP ILM configuration (RFC destination) for the communication with the KGS CS. | |
Password | String | Password from the SAP ILM configuration (RFC destination) for the communication with the KGS CS. | |
Ignore past Retention Date | Checkbox | When activated, ILM PropPath requests that want to put the expiration_date attribute in the past are accepted. This feature may be useful when migrating ILM data. | Inactive |
Enable ArchiveLink Reference check | Checkbox | This parameter can be activated if an ILM resource represents a reference to an ArchiveLink document and is to be blocked by expiration_date and legal_hold (PROPPATCH). | Inactive |
Allow ILM Duplicates | Checkbox | When enabled, ILM Put requests that want to create a resource that already exists, will be answered successfully if the sizes coincide. Inactive: These ILM PUT requests are rejected | Inactive |
Force Deletion | Checkbox | Attempts to deregister the corresponding ILM resource in the event of a faulty deletion. | Inactive |
ContentServer - Content-Repositories
Some parameters can be defined content repository specific. These can be set by following the menu option Main → ContentServer4ArchiveLink as shown below:
Configuration parameters for Content-Repositories
Security
Parameter Name | DataType | Description | Default |
|---|---|---|---|
Security | Int | 0: Security Inactive 1: Security Active 2: Security Active. Seperate administration via CSAdmin necessary This parameter can be defined Content Repository specific. | |
| SecurityChangeOnCommand | CSV list of ArchiveLink requests (non-case sensitive), e.g. create, delete, update, etc. When a request that is maintained in this list arrives, the value set in the Secutity parameter is inverted to process this request. Example 1: Security=2 à the SecKey procedure is acive. SecurityChangeOnCommand=get,delete,info The incoming GET request is processed WITHOUT checking the SecKeys incl. Expiration. Example 2: Security=0 the SecKey procedure is not active. SecurityChangeOnCommand=get,delete,info The incoming GET request is processed WITH examination of the SecKeys incl. Expiration. This parameter can be defined Content Repository specific. | ||
| Allowed Clients | Only the clients specified here (IPs or hostnames) may write to the archive (create, update etc.). If no client is specified, all clients may write. The parameter is to be created as a CSV list. If a client is not listed, they receive the RC 401 à unauthorized. This parameter can be defined Content Repository specific. | ||
| Allowed CSAdmin Clients | Only the IP addresses or hostnames specified here (SAP server) are authorized to use the CSAdmin function in SAP. Requests from other IPs or hosts receive the RC 401 → unauthorized. This parameter is to be created as a CSV list. The last IP segment can be used a wildcard. For example; ContentServer.AllowedCSAdmin=sapadm,192.168.1.2,192.168.2.* This parameter can be defined Content Repository specific. |
RFC
Parameter Name | DataType | Description | Default |
|---|---|---|---|
RFC connection | Dropdown | Select the RFC connection configured in the KGS SAP Connector |
For older versions
Viewer
Parameter Name | DataType | Description | Default |
|---|---|---|---|
Enable Viewer | Checkbox | To use the KGS H5 Viewer (EN) with the KGS ContentServer, the Enable Viewer checkbox must be set within the desired repository. | |
Viewer Context | Dropdown list | Name of the used KGS Viewer profile. |
Index Export
Parameter Name | DataType | Description | Default |
|---|---|---|---|
Index Export | Dropdown list | Off: Function deactivated. Internal: Additional attributes of the documents are determined via the ContentServer after creation of a document by RFC (pull procedure). External: Additional attributes are transferred to the ContentServer (push procedure) via the SAP Event Mechanism. | off |
Common
Parameter Name | DataType | Description | Default |
|---|---|---|---|
| Description | Description for the specific Content Repository | ||
| Disable Delete | Delete requests will not be processed/rejected for this Content Repository. |
Backend
Parameter Name | DataType | Description | Default |
|---|---|---|---|
| Check Backend Mode | Dropdown list | If activated, when processing the serverInfo request, access to a random DocId for each Content Repository is checked. This parameter can be defined Content Repository specific. CAUTION: Only use this for troubleshooting! | Off |
Components
Parameter Name | DataType | Description | Default |
|---|---|---|---|
Sign and Verify Content | Checkbox | Creates a hash value and signs this with a timestamp. When the data is called, the hash value is verified against the signature. This parameter can be defined Content Repository specific. | Inactive |
SecurityProvider | Dropdown list | Currently only timestamp signatures with certificate are available. This parameter can be defined Content Repository specific. | TrustedTimestamp with Certificate |
| Exclude Components from signing | String | Excludes individual components from signing. This parameter can be defined content repository specific. | note;kgsannotation;descr;pagelist |
Compression Size (Mb) | Double | Defines that components equal or greater than the value specified here (in MB) should be compressed. This function is only supported if the DMS supports the “DMS_COMP_PROPERTY_COMPRESSI ONSTRING” property. For example: 1 → 1 MB 0.0488 → 50KB 0.1953 → 200KB 12.5 → 12.5MB 0.6835 → 700KB 0.0009765 → 1KB This parameter can be defined Content Repository specific. | 0.0 |
| Compression Mime Types | String | CSV list of MimeTypes that should be compressed. If this parameter is not defined, the compression will be applied to all MimeTypes (=*). For example; CompressMimeType=application/pdf,image/tiff Apart from MimeTypes, document types can also be defined, if the SAPMimeExtentionLookup parameter was configured. The MimeType for the document category is then determined by RFC using the SAP table TOADD. This parameter can be defined Content Repository specific. | |
Convert Single to Multipage Tiff | Checkbox | If enabled, during runtime, single page-tiffs (data1, data2, etc. components) are converted to multipage tiff format for display. The document in the archive will not be changed. This parameter can be defined Content Repository specific. | Inactive |
Configuration for SAP communication
For features like getting MimeTypes & IndexDownload, you need to configure the RFC connection to the SAP server.
Plese keep in mind that you have to provide the SAP JCo, before you can use these features: Install SAP Java Connector (SAP JCo)
SAP Connector configuration (newer than v5.1.0)
Create a SAP Connection & select it in the RFC tab inside the ContentServer main-configuration or Content Repository specific configuration.
RFC configuration (until v5.1.0)
Configure these parameters inside the RFC tab
Parameter Name | DataType | Description | Default |
|---|---|---|---|
Client | String | Client of the SAP System | |
User | String | Login Username | |
UserPasswd | String | Login Password | |
Language | String | Login Language | |
System | String | System ID or Name of the SAP System | |
ASHost | String | Hostname or IP address of the SAP application server. | |
Group | String | Group name of the SAP application server. | |
GWHost | String | Hostname or IP address of the SAP gateway server. | |
GWServ | String | Service number of the SAP gateway server. | |
MSHost | String | Hostname or IP address of the SAP message server. |
→ SAP-Customizing & ArchiveLink Security (CS) | KGS ContentServer4Storage (EN)