A P I-S C H n IT TS T E l l E n - Ceyoniq Technology GmbH

API-Schnittstellen
FAcTS & FeATureS
Die flexible Anpassung an die spezifischen Anforderungen
eines Dokumentenmanagement-Systems: Einfach, schnell und
durchdacht mit den nscale API/Schnittstellen.
nscale bietet viele Schnittstellen auf unterschiedlichen ebenen und
ist damit ein sehr flexibles und mächtiges Werkzeug. Die heutigen
Anforderungen an ein Dokumentenmanagement-System können
sehr unterschiedlich und anspruchsvoll sein. Fast immer ist es not-
wendig, das System an spezifische Anforderungen und Wünsche
anzupassen. Mit den durchdachten nscale Schnittstellen und APIs
kann dies schnell und einfach erfolgen. Im Laufe der Zeit hat nscale
viele entwicklungszyklen durchlaufen. Die Schnittstellen wurden
dabei immer weiter verbessert, wobei stets großer Wert auf die
einfache und langfristige Benutzbarkeit gelegt wurde.
Facts
nscale Server Application Layer Schnittstellen: Standard API
Die Advanced connector (Ac) Schnittstelle stellt alle Funktionalitä-
ten als gesonderte Services bereit – und das in Java, VB und c#.
1a • Veränderung der Parameter eines API-Aufrufs,
bevor er durch die Business-Logik bearbeitet wird.
1b • Veränderung der rückgabewerte eines API-Aufrufs,
nachdem er durch die Business-Logik bearbeitet wurde.
1c • Möglichkeit, einen API-Aufruf komplett zu überschreiben.
In diesem Fall kann eine Implementierung einer völlig
eigenen Business-Logik folgen. Die Server Application
Layer eigene Business-Logik wird dabei vollständig außen
vor gelassen.
Ceyoniq Technology GmbH
Boulevard 9
33613 Bielefeld
Tel. +49 521 9318-1000
Fax +49 521 9318-1111
info@ceyoniq.com
www.ceyoniq.com
Key FeATureS
• nscale Schnittstellen sind in allen
modernen Sprachen verfügbar
• Zusätzlich zu den sehr gut doku­
mentierten APIs gibt es viele
Sample Klassen und Step-by-Step
Anleitungen zur Benutzung der
nscale APIs.
• Die bereits sehr flexiblen Schnitt­
stellen sind mittels Standard -
Mechanismen beliebig erweiterbar.
API-SCHnITTSTEllEn

API-SCHnITTSTEllEn
1d • Mit Hilfe des Plugin-Mechanismus des Server Application
Layers lassen sich neue Klassen und ganze Bibliotheken
dem Server bekanntgeben. Über diesen Mechanismus ist
es möglich, neue Funktionalitäten dem System hinzuzufü-
gen und die Arbeitsweise des Server Application Layers in
verschiedenster Hinsicht zu erweitern und zu verändern.
1e • Möglichkeit, eigene Aufgaben/Job-Implementierungen
zu schreiben. Hiermit lassen sich eigene, zeitgesteuerte
Aufgaben umsetzen.
1f • Möglichkeit, die abzusetzenden SQL Statements zu
verändern, bevor sie an die Datenbank engine als Anfrage
gestellt werden.
nscale Pipeliner Schnittstellen: Standard API
• Alle relevanten Objekte für die Pipeliner­Laufzeit können
über die SDKs (Java, c++) abgefragt werden. Änderungen
an bestehenden Objekten zur Laufzeit sind über das SDK
möglich. Zudem gibt es ein Plugin-Konzept, welches der
nscale Pipeliner in Java und c++ anbietet.
• Es gibt eine SNMP (Simple Network Management Proto-
col) Monitoring-Schnittstelle für Windows (SNMP exten-
sion Agent DLL) und unix (Integration in net-snmp).
• In der Pipeliner­Blockverarbeitung gibt es eine sehr umfang­
reiche Vorverarbeitungsstrecke, bei der viele der üblichen
Vorverarbeitungs-Fragestellungen per Konfiguration
(über Analyzer) abgedeckt werden. Falls das nicht reicht,
kann man blockweise die Daten „on the fly“ mit selbst-
programmierten DLL- bzw. eXe-Aufrufen bearbeiten.
2a • Im Kommandozeilen-Plugin kann man, BEvOr die Block-
verarbeitung beginnt, die eingehenden Dateien modifizie-
ren. Das ist häufig nützlich für Korrekturen bei „unflexiblen“
Datenlieferanten und Überarbeitungen, welche die
ganze Datei benötigen.
2b • Die (selbsterstellten) Plugins (egal, ob c++- oder Java-
Plugins) können über die Pipeliner Ablauf steuerung (rou-
ting) integriert werden. Diese Integration ist je „Spoolklas-
sifikation“ konfigurierbar.
nscale Server Storage Layer Schnittstellen: Standard API
• Die Base Connector Schnittstelle stellt alle Funktionen
des nscale Server Storage Layers bereit. Üblicherweise
wird sie nicht direkt angesprochen, sondern implizit durch
den nscale Server Application Layer. es gibt aber auch
Produkte und Szenarien, die diese Schnittstelle ggf. direkt
ansprechen (z. B. der nscale Pipeliner).
• D ie API ist als Java und c++ Variante verfügbar.

nscale Administrator Schnittstellen: Admin SDK
• Über das Administrator SDK ist es möglich, eigene
„Adminis trierungsknoten“ in den nscale Administrator zu
integrieren, d. h. innerhalb der ordnerbasierten Struktur des
nscale Administrators können eigene Software-Kompo-
nenten eingetragen werden.
• Die Komponenten haben vollen Zugriff auf alle nscale
und Third-Party APIs, die der Administrator zur Verfügung
stellt (Advanced connector, Baseconnector, Pipeliner API,
Datenbank client Treiber).
• Über den nscale remote Management Service (rMS) kann
auch auf fremde rechner zugegriffen werden, sofern
der rMS auf diesem System installiert ist. Damit sind
im nscale Administrator Datei-basierte Konfigurations-
änderungen auf entfernten rechner möglich.
4a • Das Administrator SDK benutzt eclipse-konforme exten-
sion Points zum Andocken in den Navigatorbaum.
• Jedes Eclipse­konforme Plugin kann in den nscale
Administrator integriert werden.
Windows Desktop client und Web Desktop client Schnittstellen:
Standard API
Grundsätzlich bieten beide clients die gleichen Schnittstellen,
auf Besonderheiten wird explizit hingewiesen.
• Die Standard­Schnittstelle der beiden Clients bietet Zugriff
auf das nscale Application Layer Objektmodell bzw.
Entitäten (Dokument, Ordner, Workflow etc.).
• Zudem kann über diese Schnittstelle auch auf nicht nscale
Server Application Layer entitäten zugegriffen werden,
z. B. auf den Suchdialog, Browser etc.
• Drittes Hauptmerkmal ist die Möglichkeit, mit der
Desktop API direkt auf den nscale Advanced connector
durchzugreifen.
5/6a • Scripting, z. B. für Masken und Layouts
5/6b • Erweiterung des Windows/Web Desktops um weitere
individuelle Funktionalitäten
• Entfernen von Standard­Funktionalitäten
API-SCHnITTSTEllEn

API-SCHnITTSTEllEn
Function
Windows Client (5)
API Plugins (b)
(a)
Scripting (a)
AC
Pipeliner (2)
API
(b)
Web Client (6) Administrator (4)
API Plugins (b)
Scripting (a)
AC
Server Application Layer (1)
API
(Advanced Connector)
Plugins (a)
Plugins (c)
API
Plugins (b)
CORE
Plugins (e)
Server Storage Layer (3)
API
(Base Connector)
Storage
Layer
eclipse
AC
Storage Layer
Pipeliner
SAP
...
Plugins (a)
Plugins (f)
SQL
runtime
Plugins (d)
Stand: November 2010