Page Comparison

...

Compiling SAPALink.dll by using a C++ compiler and calling it directly
Using JAVA and KGS Generic Storage Provider in order to connect the DMS archive.

You will have to implement the given provided method bodies.

This includes methods like LinkOpen to open a connection to your own archive or all required functions for CREATE.

...

SAP System ↔ KGS ContentServer4Storage ↔ (Generic Storage Provider) ↔ SAPALINK-Implementation ↔ Store/DMS of the customer

Downloading SAPALink SDK

Das You may download the KGS SAPALink SDK ist im Downloadbereich from our download area https://download.kgs-software.com/ (Version SAPALink_SDK_v210H.zip)zu finden. → KGS SAPALink Framework API

Description of the ZIP-Container

...

Docu
- SAPALink Add-On 2_10A.pdf
- SAPALink Query.pdf
- SAPALink SDK ImpRevGuide 210H.pdf
Runtime
- SAPALink.DAT
- SAPALINKTEST.exe
- Storage-profile.txt
SAPALINK
- C++ sources for SAPALink.dll
SAPALINK.JAVA
- DMSException.java
- SAPALink.java
SAPALINKTEST
- Sources (C++) for SAPALINKTEST.exe
TestdocumentsTest documents
- Some test documents (tif,pdf)

...

Description:

Docu:

Beinhaltet neben der eigentlichen SAPALINK SDK Anleitung auch zwei KGS-spezifische Anleitungungen. It contains the SAPALink SDK manual as well as two KGS specific manuals.
SAPALink Add-On 2_1 bezieht sich hierbei auf die erweiterten Fuktion "componentCreateCOLD" sowie die Funktion "DocumentKeysSet"10A.pdf refers to extended functionalities componentCreateCOLD as well as DocumentKeysSet.

Info
componentCreateCOLD ist veraltet ("depreceated") und wird in der OSGi-ContentServer-Version nicht mehr unterstützt is deprecated and will not be supported by the OSGi-ContentServer4Storage-Version!

2. Runtime:

Der Runtime Ordner behinhaltet ein bereits kompiliertes Programm "The runtime directory contains the compiled SAPALINKTEST.exe", mit welcher sich die Funktionalität einer eigenen Implementierung testen lassen. Wir empfehlen dennoch das KGS API Tester hierfür zu nutzen, which you may use in order to test your implementations. It's still recommended to use the KGS API Tester application in order to test your implementations.
SAPALink.DAT wird als "is being used as a Settings-Datei" vom file by SAPALINKTEST.exe verwendet.
Storage-profile.txt muss auf eine gültige has to point to a valid KGS Storage-Configuration zielen.

3. SAPALINK

In diesem Ordner liegen die unkompilierten This folder contains the uncompiled C++ -Quellen einer SAPALINK (dll)-Implementierung. Ist es gewünscht eine eigene SAPALINK-Implementierung ohne zuhilfenahme des OSGisources of SAPALink.dll-implementation. It is required to use your own SAPALink-Implementation without using the OSGI-Generic-Store -Bundles bundles (für for SAPALINK.JAVA) zu nutzen, so müssen alle Funktionen in diesen Quellen ausimplementiert werdenall methods of this source have to be implemented.

4. SAPALINK.JAVA

Insofern die Klassen in JAVA geschrieben werden, so sind die beiden Dateien (DMSException für Errorhandling sowie SAPALink.java für die zu implementierenden Methoden) auszuimplementieren und mit einem Java-compiler zu kompilierenIf you are implementing your classes in JAVA you will have to implement DMSException (for error handling) as well as SAPALink.java for each required method and compile it.

5. SAPALINKTEST

Um zu sehen, wie der In order to understand how SAPALINKTEST (c++) kompiliert wurde und in die Methoden zu schauen hat die KGS sich entschlossen diesen Quellcode zu Verfügung zu stellenworks and which methods are being provided KGS decided to provide you with the source code.

6. TestDocuments

eine handvoll Dateien zum Testen. es kann auch jede andere beliebige Datei genutzt werdenIt contains some test files. You may also use any other file.

Java-

...

Implementation with the help of OSGi as well as KGS ContentServer

...

Der von KGS bevorzugte Weg den Kunden mit der SAPALink Implementierung zu unterstützen ist der Weg mit Java und dem aktuellen OSGi-Container. Hierzu müssen die Klassen "SAPALink.java" sowie "DMSException.java" aus dem Ordner SAPALINK.JAVA (siehe oben) implementiert werden. In dieser Anleitung wird ein Beispiel zu den (simplen) Methoden "infoGetVendorName()" und "infoGetProductName()" ausimplementiert.

...

KGS recommends you to implement SAPALink in Java and using the recent OSGi container. In order to implement it, you'll have to implement SAPALink.java as well as DMSException.java.
In this manual, we'll provide you with some very basic example of how to implement the methods infoGetVendorName() as well as infoGetProductName()

Within the classes, you may find the method bodies as well as some comments about the functions, the results, and parameters.

Code Block

language	java
theme	Eclipse
title	infoGetVendorName

// --------------------------------------------------------------------
	// Function: infoGetVendorName
	//
	// Returns the vendor’s name as a String.
	// Parameters: none
	// Returncode: vendor’s name -->  String
	// --------------------------------------------------------------------
	public String infoGetVendorName() throws DMSException
	{
		String csRet = null;
		return csRet;
	}

...

As you might have noticed, this method is trying to get the vendor name. You may return any name (e.g.: "Max Mustermann AG").

Code Block

title	Example Implementation

public String infoGetVendorName() throws DMSException
	{
		return "Max Mustermann AG";
	}

Info

title	Vorsicht

Es wird dringend empfohlen auf Sonderzeichen zu verzichten (sowie It's strongly recommended to refrain from using special characters (including UTF-8) zu nutzen.

...

.

...

Code Block

language	java
title	infoGetProductName

// --------------------------------------------------------------------
	// Function: infoGetProductName
	// Returns the name of the product (DMS) as a String.
	// Parameters: none
	// Returncode: product name -->  String
	// --------------------------------------------------------------------
	public String infoGetProductName() throws DMSException
	{
		String csRet = null;
		return csRet;
	}

...

You will have to define a product name (e.g.: "Magic Archive").

Code Block

language	java

	public String infoGetProductName() throws DMSException
	{
		return "Magic Archive";
	}

...

In order to test it, you may also implement the methods infoGetProductVersion as well as infoGetLinkVersion.

b) Kompilieren

dies Javaklasse "SAPALink.java" können wir nun mithilfe eines beliebigen Java SDKs kompilieren. Dies ist entweder über eine IDE oder über die CommandLine möglich. Zu verkürzung wird hier über die Windows Command Line gearbeitet (die Befehle sind analog zu Unix).

Das ein Java SDK bereits auf dem System installiert und lauffähig ist wird vorrausgesetzt. Es wird in den Ordner via CommandLine mit der Javaklasse navigiert und mit dem Befehl "javac SAPALink.java" die Klasse(n) kompiliert:

Image Removed

Es sollten nun zwei weitere Dateien in dem Ordner vorhanden sein: SAPALink.class und DMSException.class.Compilation

The JAVA class SapaLink.java may now be compiled by using any Java SDK. You may either compile it by using the features of your IDE or via the command line.

Due to the variety of IDEs, we provide you with the command line option (please note that there is no difference between the commands used in Microsoft Windows or Linux/Unix).

It is being assumed that you already installed a Java SDK. You may compile the class/-es by using the following command:

Image Added

Once the command finished the compilation process, two additional files should exist within the directory.

SAPALink.class
DMSException.class

Configuration of KGS Generic Store Providers and usage of SAPALink.class

Es wird eine standardinstallation des KGS ContentServers (auf OSGi-Basis) vorrausgesetzt. A standard installation of KGS ContentServer4Storage (based on OSGi) is being assumed.

Info

title	Info

Alle hier vorgeführten Oberflächenkonfigurationen (per WebGUI) können auch per Config-Files umgesetzt werden.

...

Please note, that all provided configurations (via WebGUI) may also be done by using the config files.

First, you may navigate to the OSGi container via WebGUI. From there you may navigate to the configuration of the Generic Store Service (the bundles of KGS Generic SAPALink Provider).

Hier konfigurieren wir zwei Parameter: Der Implementierungspfad und ein Flag bezüglich der nutzung von einer externen SAPALink Implementierung. Konkret sind das die Parameter: "Implementation Folder" und "Use internal Implementation".

Image Removed

Der Implementation Pfad muss auf den Ordner zeigen, in dem unsere kompilierten Klassen (SAPALink.class und DMSException.class) liegen. "Use internal Implementation" muss auf "false" gestellt werden.

"true" (default) würde immer die KGS Store Implementierung (und somit per Konfiguration aus der Storage.conf) auswählen.

Nun starten wir den Webserver neu.

Nach einem Neustart sollten wir nun in der Oberfläche des KGS ContentServers unsere Änderungen sehen:

Image Removed

dies sollte sich auch in der SAPALink Info (Unter "Main → SAPALink Info" wiederspiegeln):

Image Removed

Auch der ArchiveLink Befehl "serverInfo" sollte uns nun das gewünschte Resultat bereitstellenWithin the configuration of the Generic Store Service you may change the Implementation Folder (the path of the SAPALink-implementation) as well the flag Use internal Implementation (which may allow you to accept external SAPALink implementations).

Image Added

The parameter Implementation Folder has to point to a directory that contains the compiled classes (SAPALink.class and DMSException.class).

Use internal Implementation has to be set to false. (If you set it to true it would always use the KGS Store implementation including the configuration via Storage.cfg).

Important! You should change the value of ILM internal Implementation also to false when your CS has a ILMLicenseKey.

Please restart the webserver.

After restarting your webserver you may see some changes within the KGS ContentServer4Storage user interface:

Image Added

Please note also the changes in the SAPALink Info (Within Main → SAPALink Info):

Image Added

The ArchiveLink command serverInfo should also return the assumed results:

http://localhost:8080/KGSAdmin-CS/contentserver?serverInfo&pVersion=0046&resultAs=ascii

Versions Compared

Old Version 2

New Version Current

Key

Downloading SAPALink SDK

Description of the ZIP-Container

Description:

Java-

Implementation with the help of OSGi as well as KGS ContentServer

Configuration of KGS Generic Store Providers and usage of SAPALink.class

Verwandte Artikel