Introduction

System requirements

Installation

Licensing

Configuration

Webservice API

Automation of configuration

Security

Testing

Testing with SOAP UI

Testing without a signed key

A normal „serviceCheck“ request for an instance “Cortex” is configured the following way.

	Configured instance of Web Service

The related SOAP UI request looks like this.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:int="http://interfaces.webservice.kgs.software.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <int:ServiceCheck>
         <!--Optional:-->
         <applicationName>Cortex</applicationName>
         <!--Optional:-->
         <username>David</username>
         <!--Optional:-->
         <seckey></seckey>
      </int:ServiceCheck>
   </soapenv:Body>
</soapenv:Envelope>

Testing MTOM with SOAP UI

Please follow the following steps to send an attachment using MTOM;

• We assume that the MTOM interfaces (located at http://Server-IP-Address:Server-Port/WebApplicationName/ webservice/apiV2?wsdl) have been configured in the SOAP UI

• Select the “ContentServerDocCreate” interface

• Configure the tag “imageData” with the following format; <imageData>cid:Name -Of-The-File-With-Extension</imageData>

• Click on the ‘Plus’ sign as shown below.

	Highlighted Plus-button in SOAP UI

• Locate your attachment and attach it.

• Click on the ‘Part’ box as shown below.

	Highlighted “Part”-column in SOAP UI

• Select the name of the attachment as shown below.

	Selected attachment in SOAP UI

• At this point, your attachment along with your create request is ready.

Testing with SOAP UI

Testing without a signed key

A normal „serviceCheck“ request for an instance “Cortex” is configured the following way.

	Configured instance of Web Service

The related SOAP UI request looks like this.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:int="http://interfaces.webservice.kgs.software.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <int:ServiceCheck>
         <!--Optional:-->
         <applicationName>Cortex</applicationName>
         <!--Optional:-->
         <username>David</username>
         <!--Optional:-->
         <seckey></seckey>
      </int:ServiceCheck>
   </soapenv:Body>
</soapenv:Envelope>

Testing MTOM with SOAP UI

Please follow the following steps to send an attachment using MTOM;

• We assume that the MTOM interfaces (located at http://Server-IP-Address:Server-Port/WebApplicationName/ webservice/apiV2?wsdl) have been configured in the SOAP UI

• Select the “ContentServerDocCreate” interface

• Configure the tag “imageData” with the following format; <imageData>cid:Name -Of-The-File-With-Extension</imageData>

• Click on the ‘Plus’ sign as shown below.

	Highlighted Plus-button in SOAP UI

• Locate your attachment and attach it.

• Click on the ‘Part’ box as shown below.

	Highlighted “Part”-column in SOAP UI

• Select the name of the attachment as shown below.

	Selected attachment in SOAP UI

• At this point, your attachment along with your create request is ready.

Scheduler

Historical Documents

The Webservice contains the proxy logic for re-routing “read” and “get” requests to a historical repository or to a historical content server. Below are few Sample Configurations.

Scenario A: The historical and new repositories are located on the same Content Server, but have different content repository Ids.

	Configuration for scenario A

Scenario B: The historical and new repositories are located on different Content Servers, but have the same content repository Id.

	Configuration for scenario B

Scenario C: The historical and new repositories are located on different Content Servers and have different content repository Ids.

	Configuration for scenario B

Document Type mapping

The following document types are mapped with the corresponding MIME-types.

In case no suitable mime type is found in our internal table (as shown above), Java will try to detect the appropriate mime-type. If no suitable mime-type is found even by Java, then an error will be re-turned. It is also possible to override the mime types or introduce new/customized mime types with the parameter “MimeType Path” available at “OSGi” -> “WebService MainConfiguration”. This op-tion allows us to specify a file which contains a table. This table can be used to override the mime type. The installation contains a sample file (\mimeType) which would allow us to override the mime types.

Example;
C:\mimetype\mime.types
Following line specifies that the “pdf” will be mapped to “application/pdf”.

application/pdf pdf
Following line specifies that both “bin” and “dms” will be mapped to “application/octet-stream”;
application/octet-stream bin dms
Following line will be ignored (‘#’ would allow the mime type reader to ignore the line);

application/ocsp-response ocsp

If the text file is updated, please restart the instance(s) in order to take effect. To configure a specific instance to read from the mimeType table, simply activate the flag “Override Mime-Types” located at “Main -> KGS Web Service -> Application Manager “. Edit the Instance configuration and under “Common”, the flag is located. Simply check the box to configure the in-stance to read from the mime type table as shown below.

	Highlighted Mime type override option