Verwendung

Der CLARC QHIX Daemon stellt Services für Client-orientierte Dokumenten- und Indexierungs-Prozesse bereit.

Über die hier vorgestellte Web-Service Schnittstelle kann auf die verwalteten Inhalte des QHIX-Servers zugegriffen werden. Die hier vorgestellten Methoden und Attribute stellen jedoch nur einen Teil der verfügbaren Funktionalität dar. Alle weiteren Funktionen sind non-public.

Die API

Genereller Aufbau einer Url:

http(s)://<server>:<port>/<function>?<parameter>

Die Parameter einer Url sollten verschlüsselt übertragen werden. Im Umfeld von CLARC ENTEPRIRSE gibt es dazu verschiedende Verschlüsselungsmethoden.

Das Ergebnis einer Anfrage wird, sofern nicht anders angegeben, im CLARC Fast XML Format zurückgeliefert.

Ein erfolgreicher Aufruf einer Web-Service Methode wird stets mit einem HTTP 200 oder HTTP 201 bestätigt.

(GET) CCCREATESESSION

Diese Methode generiert eine neue QHIX Session oder verbindet sich zu einer bestehenden.

Parameter	Beschreibung
Übergabe
user	Login-Benutzername.
password	Benutzer-Passwort.
sessionid	Optional - bestehende Sitzungs-Id des Clients.
Ergebnis
result	true/false
sessionid	Die erzeugte Sitzungs-Id. Diese muss ab jetzt bei jeder Anfrage mit übergeben werden.
instancetoken	Instanz-Token des QHIX-Servers.
message	Nachricht zum Ergebnis des Logins.

(GET) CCCLOSESESSION

Diese Methode beendet eine QHIX Session.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
Ergebnis
message	Nachricht zum Ergebnis des Logouts.

(GET) CCGETOEMINFOS

Diese Methode liefert die entsprechenden OEM Informationen. Weitere Informationen zur OEMisierung finden Sie in der entsprechenden Dokumentation.

Parameter	Beschreibung
Übergabe
sessionid	Optional - bestehende Sitzungs-Id des Clients.
Ergebnis
aboutimage	Base64 kodiertes JPEG für den About Dialog.
company	Firmenbezeichnung.
copyright	Copyright-Bezeichnung.
frontimage	Base64 kodiertes JPEG für die Startansicht.
helplink	Url zur Online-Hilfe.
infolink	Url zu Online-Informationen.
infomail	eMail-Adresse für Informationsanfragen.
loginimage	Base64 kodiertes JPEG Image für den Login-Dialog.
longproductname	Langbezeichnung des Produktnamens.
mainwindowicon	Base64 kodiertes ICO Image.
productname	Standard-Produktbezeichnung.
shortproductname	Kurzbezeichnung des Produkts.
supportlink	Url für Support-Anfragen.
supportmail	eMail-Adresse für Supportanfragen.

(GET) CCGETBASICS

Diese Methode liefert die Basis-Server-Informationen.

Parameter	Beschreibung
Übergabe
sessionid	Optional - bestehende Sitzungs-Id des Clients.
Ergebnis
build	Detaillierte QHIX-Server Version.
serverversion	Lizenzversion des QHIX-Servers.
numberofprocessors	Die Anzahl der am Server verfügbaren CPU-Kerne.
serverdateformat	Datumsformat am Server bzw. im C4 definiert.
remotequeryurl	Url zum REMOTEQUERY Server.
stackidauto	Gibt an, ob die Id's für die Generierung von Stapelnummern automatisch erfolgt.
stackidregex	Regulärer Ausdruck zum Format von Stapelnummern.

(GET) CCGETUSERINFO

Diese Methode liefert alle Informationen zum angegebenen Benutzer.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
user	Benutzername.
Ergebnis
...

(GET) CCGETPERMOBJECTS

Diese Methode liefert alle verfügbaren Berechtigungsobjekte zum angegebenen Benutzer.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
user	Benutzername.
type	Applikationstyp: /QHIX/dSign /QHIX/eWork /QHIX/xControl
Ergebnis
node	Beschreibungstext der Anwendung. Alle weiteren Informationen werden über die Attribute des Knotens "node" übergeben: id application stackprocessing color documentcount stackblobcount reserveblobcount Color wird als Web-Color in der Form #RRGGBB übergeben.

(GET) CCGETSAPWORKQUEUEID

Diese Methode liefert die für den angegebenen Benutzer passende und verfügbare SAP Applikations-Id.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
user	Benutzername.
logicalsystemname	Name des logischen SAP Systems.
Ergebnis Das Ergebnis ist Text/Plain und beinhaltet die ApplicationId. Wurde keine passende Anwendung gefunden, bleibt das Ergebnis leer.

(GET) CCREGISTERSESSION

Diese Methode registriert eine Anwendungssitzung für das angegebene Objekt.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
user	Benutzername.
stackid	Optionale Stapel-Id.
object	Name oder Id des Berechtigungsobjekts. Siehe CCGETPERMOBJECTS > Application bzw. Id.
token	Optional - ASE Session-Token.
Ergebnis
result	true/false
token	ASE Session Token.
message	Info-Text.

(GET) CCRELEASESESSION

Diese Methode gibt eine registrierte Anwendungssitzung für das angegebene Objekt frei.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
user	Benutzername.
object	Name oder Id des Berechtigungsobjekts. Siehe CCGETPERMOBJECTS > Application bzw. Id.
token	Optional - ASE Session-Token.
Ergebnis
result	true/false
message	Info-Text.

(GET) CCSESSIONHEARTBEAT

Diese Methode zeigt die Aktivität des Clients an. Der Heartbeat darf einen maximalen zeitlichen Abstand von 10 Minuten haben.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
token	ASE Session-Token.
Ergebnis
result	true/false
token	Der gesendete Token.
message	Info-Text.

(GET) CCGETBLOBLIST

Diese Methode ruft eine Liste von Blobs aus dem angegebenen Bereich ab.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
queue	QHIX Queue Name oder id.
state	Status der Blobs: IDLE ONHOLD
tacked	Heftungen true/false.
user	Benutzername.
stackid	Stapel-Identifier.
Ergebnis Das Ergebnis ist ein XML mit dem nachfolgenden Aufbau.

<?xml version="1.0" encoding="UTF-8" ?>
<ccBlobs>
  <Blob Id="..." TackId="..." SortId="0" Extension=".pdf" DocType="" MimeType="application/pdf" Size="827823" Date="000B3B9Dh0336106Eh">Example</Blob>
  <Blob Id="..." TackId="..." SortId="1" Extension=".pdf" DocType="" MimeType="application/pdf" Size="835421" Date="000B3B9Dh0336106Eh">MoreExample</Blob>
  ...  
</ccBlobs>

(GET) CCGETBLOB

Diese Methode ruft ein angegebenes Blob vom Server ab. Das Ergebnis ist der entsprechende Bytestream mit dem MimeType des angeforderten Dokuments.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
id	Id des Blobs.

Im HTTP Header werden zudem zwei Attribute zurückgeliefert:

BlobId
BlobHash

(GET) CCDELETEBLOB

Diese Methode löscht das angegebene Blob vom Server.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
id	Blob-Id.

(GET) CCCHANGEBLOB

Diese Methode ändert das angegebene Blob am Server.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
id	Blob-Id.
sortid	Neue Sortierungs-Id.
tackid	Neue Heftungs-Id.
State	Neuer Blobstatus: IDLE ONHOLD

(GET) CCGETTACKLIST

Diese Methode ruft eine Liste von Blobs aus dem angegebenen Bereich ab.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
queue	QHIX Queue Name oder id.
user	Benutzername.
stackid	Stapel-Identifier.
Ergebnis Das Ergebnis ist ein XML mit dem nachfolgenden Aufbau.

<?xml version="1.0" encoding="UTF-8" ?>
<ccDocuments>
  <Document Id="..." Date="000B3B9Dh0336106Eh" Blobs="3">
    <Subject>Betreff des Dokuments</Subject>
    <Messages>Hinweise zum Dokument</Messages>
  </Document>
  ...  
</ccDocuments>

(GET) CCGETTACK

Diese Methode ruft ein angegebenes Dokument vom Server ab. Das Ergebnis ist der entsprechende XML Bytestream des angegebenen Dokuments im CLARC Document XML Format.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
id	Id der Heftung.
includeblobs	True/False - bei True werden die Blob-Referenzen im Result mit übergeben.

(GET) CCDELETETACK

Diese Methode löscht das angegebene Dokument vom Server.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
id	Id der Heftung.
keepblobs	Gibt an ob die Blobs der Heftung bestehen bleiben sollen damit diese ggf. wiederverwendet werden können.

(GET) CCGETAPPPROPERTIES

Diese Methode ruft detaillierte Informationen zur angegebenen Anwendung vom Server ab.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
application	Name oder Id der QHIX Anwendung.

(GET) CCGETAPPINFOS

Diese Methode ruft allgemeine Informationen zur angegebenen Anwendung vom Server ab.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
application	Name oder Id der QHIX Anwendung.
Ergebnis
id	Anwendungs-Id.
name	Name der Anwendung (Pfad).
description	Anwendungsbeschreibung.
documentcount	Anzahl der Heftungen.
stackblobcount	Anzahl der Blobs im Stapel.
reserveblobcount	Anzahl der Blobs in der Rückstellung.

(GET) CCGETFIELDSCHEME

Diese Methode ruft das angegebene Feldschema vom Server ab.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
scheme	Name des Feldschemas. SIehe auch Feldschemas.
Ergebnis
subjectfields	Komma getrennte Liste der Betreff-Felder.
fields	Komma getrennte Liste aller Felder des Schemas.
description	Feldschemabeschreibung.
<Feldname>_<Property>	...

(GET) CCGETSCANPROFILES

Diese Methode ruft einer Liste der verfügbaren Scannerprofile für den jeweiligen Host vom Server ab.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
host	Name des Host-Systems.
Ergebnis
node	Name des Profils.

(GET) CCGETSCANPROFILE

Diese Methode ruft das angegebene Scannerprofil für den jeweiligen Host vom Server ab.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
host	Name des Host-Systems.
profile	Name des Scannerprofils.
Ergebnis Liste der C4 Properties mit Werten zum angegebenen Scanner-Profil. Siehe /clarc/Software/clarc qhix daemon/Profiles/Scanner.

(GET) CCDELETESCANPROFILE

Diese Methode löscht das angegebene Scannerprofil für den jeweiligen Host vom Server.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
host	Name des Host-Systems.
profile	Name des Scannerprofils.

(GET) CCGETSTACKLIST

Diese Methode ruft einer Liste der verfügbaren Stapel für die angegebene Anwendung vom Server ab.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
queue	Name der QHIX Anwendung.
Ergebnis
stack	Name des Stapels
...	...

(GET) CCGETSTACKID

Diese Methode ruft eine neue StapelId vom Server ab.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
queue	Name der QHIX Anwendung.
Ergebnis Neue StapelId las Text/Plain.

(PUT) CCBLOBUPLOAD

Diese Methode überträgt ein Blob als Bytestream an den Server und verknüpft es mit der entsprechenden Anwendung und Benutzer.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
blobid	Id des Blobs (32 Stellen) - siehe CreateId.
extension	Extension des Files (z.B. .pdf)
hash	MD5 Hashwert des Blobs.
name	Anzeigename des Blobs.
sortid	Sortierrreihenfolge des Blobs.
queue	Name oder Id der QHIX Anwendung.
user	Benutzer / Uploader.
tackid	Optionale Heftungs-Id.
stackid	Optionale Stapel-Id.
update	Blob-Update (z.B. bei einer Änderung wie drehen) - true/false.

Im HTTP Header werden zudem zwei Attribute zurückgeliefert:

BlobId
BlobHash

(PUT) CCDOCUMENTUPLOAD

Diese Methode überträgt ein Dokument als XML Bytestream im CLARC Document XML Format.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
queue	Name oder Id der QHIX Anwendung.
uploader	Benutzer / Uploader.
justlinkrefs	Definiert ob die angegebenen Blob-Referenzen lediglich verlinkt werden sollen.

Im HTTP Header werden zudem zwei Attribute zurückgeliefert:

DocId

(PUT) CCDOCUMENTUPDATE

Diese Methode überträgt ein Dokument als XML Bytestream im CLARC Document XML Format und ersetzt das bestehende Dokument damit.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
updater	Benutzer / Uploader.

Im HTTP Header werden zudem zwei Attribute zurückgeliefert:

DocId

(PUT) CCEXPORT

Diese Methode übermittelt eine Liste an Dokumenten-Id's in Form eines XML's welche dem entsprechend konfigurierten Nachfolgeprozess zugeführt werden sollen.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.

Das XML hat folgenden Aufbau:

<?xml version="1.0" encoding="UTF-8"?>
<ccExport FormatVersion="1.7" Compressed="false" Encoding="none">
  <Id>...</Id>
  <Id>...</Id>
  ...
</ccExport >

(PUT) CCCHANGEBLOBS

Diese Methode übermittelt eine Liste an Blob-Id's in Form eines XML's mit entsprechenden Informationen zur Änderung.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.

Das XML hat folgenden Aufbau:

<?xml version="1.0" encoding="UTF-8"?>
<ccBlobs FormatVersion="1.7" Compressed="false" Encoding="none">
  <Id TId="[TackId]" SId="[SortId]" State="[ONHOLD|IDLE]">[BlobId]></Id>
  ...
</ccBlobs>

(PUT) CCSETTRAININGDATA

Diese Methode übermittelt Trainingsinformationen in Form eines XML's.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
queue	Name oder Id der QHIX Anwendung.
docid	Dokumenten-Id.
keyfield	Name des Schlüsselfeldes.
keyvalue	Schlüsselbegriff für die Zuordnung.

Das XML hat folgenden Aufbau:

<?xml version="1.0" encoding="UTF-8"?>
<ccTraining FormatVersion="1.7" Compressed="false" Encoding="none">
  <[FieldName] DataType="[DataType]" Page="[PageId]" TwipsZone="[L,T,R,B]">[BlobId]>[Trained Value]</[FieldName]>
  ...
</ccTraining >

Im HTTP Header werden zudem zwei Attribute zurückgeliefert:

DocId

(PUT) CCSETSCANPROFILE

Diese Methode übermittelt ein Scanner-Profil in Form eines XML's an den Server.

Parameter	Beschreibung
Übergabe
sessionid	Bestehende Sitzungs-Id des Clients.
host	Host-Name.
profile	Name des Scannerprofils.

Verwendung

Die API

(GET) CCCREATESESSION

(GET) CCCLOSESESSION

(GET) CCGETOEMINFOS

(GET) CCGETBASICS

(GET) CCGETUSERINFO

(GET) CCGETPERMOBJECTS

(GET) CCGETSAPWORKQUEUEID

(GET) CCREGISTERSESSION

(GET) CCRELEASESESSION

(GET) CCSESSIONHEARTBEAT

(GET) CCGETBLOBLIST

(GET) CCGETBLOB

(GET) CCDELETEBLOB

(GET) CCCHANGEBLOB

(GET) CCGETTACKLIST

(GET) CCGETTACK

(GET) CCDELETETACK

(GET) CCGETAPPPROPERTIES

(GET) CCGETAPPINFOS

(GET) CCGETFIELDSCHEME

(GET) CCGETSCANPROFILES

(GET) CCGETSCANPROFILE

(GET) CCDELETESCANPROFILE

(GET) CCGETSTACKLIST

(GET) CCGETSTACKID

(PUT) CCBLOBUPLOAD

(PUT) CCDOCUMENTUPLOAD

(PUT) CCDOCUMENTUPDATE

(PUT) CCEXPORT

(PUT) CCCHANGEBLOBS

(PUT) CCSETTRAININGDATA

(PUT) CCSETSCANPROFILE

Siehe auch

Browser nicht unterstützt