CIB doXiview - Integration

Die Kommunikationsschnittstellen

Das archive Interface

Allgemein
getNextArchiveObjectId
getPreviousArchiveObjectId
beforeArchiveLoad
afterArchiveLoad

Allgemein

CIB doXiview kann über die Server-seitige Schnittstelle CIB Archive API an ein Archivsystem angebunden werden, um von dort Dokumente zu laden und anzuzeigen.

Das Interface archive definiert Funktionen, welche in diesem Fall Client-seitig zur Kommunikation benötigt werden.

Es ist aus Sicht des Masters in Form des Objekts CibArchiveMasterFunctions verfügbar.

Für weitere Informationen zur Anbindung von CIB doXiview an ein Archivsystem sei auf die separate Dokumentation CIB doXiview - Archivmodus verwiesen.

getNextArchiveObjectId

Diese Funktion wird lediglich für die Anzeige von Archivdokumenten benötigt.

Über eine entsprechende Schaltfläche in CIB doXiview kann der Benutzer zum nächsten anzuzeigenden Archivobjekt navigieren. Welches das nächste Archivobjekt ist, erfragt CIB doXiview daraufhin mit der Funktion getNextArchiveObjectId bei seinem Master. Typischerweise hat die Master-Anwendung aktuell eine Menge von Archivobjekten aufgelistet, z.B. ein Suchergebnis.

Function

Parameters

Return

getNextArchiveObjectId

archiveObjectId: String

JSON

Returns based on the given current archive object id the information about the next archive object. If no archive object was loaded in the current session the parameter will be null.

Parameter description:

String: archiveObjectId:

The id of the currently loaded archive object or null if no archive object is loaded.

Return:

A JSON representation of the archive object information with the following structure:

var res = {
  archiveObjectId: "the next archive object id"
  archiveDocumentIndex: "the index of the next archive object"
  first: "whether or not it is the first archive object"
  last: "whether or not it is the last archive object"
  }

Registration by master:

master.archive.registerGetNextArchiveObjectIdCallback(callback: FunctionCallback);

getPreviousArchiveObjectId

Diese Funktion wird lediglich für die Anzeige von Archivdokumenten benötigt.

Analog zu getNextArchiveObjectId fragt CIB doXiview seinen Master nach der vorherigen Archivobjekt-Id, wenn der Benutzer eine entsprechende Schaltfläche in CIB doXiview betätigt.

Function

Parameters

Return

getPreviousArchiveObjectId

archiveObjectId: String

String

Returns based on the given current archive object id the previous archive object id. If no archive object was loaded in the current session this parameter will be null.

Parameter description:

String: archiveObjectId:

The id of the currently loaded archive object or null if no archive object is loaded.

Return:

A JSON representation of the archive object information with the following structure:

var res = {
  archiveObjectId: "the next archive object id"
  archiveDocumentIndex: "the index of the next archive object"
  first: "whether or not it is the first archive object"
  last: "whether or not it is the last archive object"
  }

Registration by master:

master.archive.registerGetPreviousArchiveObjectIdCallback(callback: FunctionCallback);

beforeArchiveLoad

Diese Funktion wird lediglich für die Anzeige von Archivdokumenten benötigt.

CIB doXiview erfragt mit der Funktion beforeArchiveLoad weitere Informationen zu dem zu ladenden Archivobjekt, bevor das Archivobjekt serverseitig geladen wird.

Function

Parameters

Return

beforeArchiveLoad

archiveObjectId: String
archiveDocumentIndex: int
metaData: String

JSON

Returns meta data for the specified archive object.

Parameter description:

```
String: archiveObjectId:
```
The id of the currently loaded archive object.
```
int: archiveDocumentIndex:
```
The current archive document index
```
String: metaData:
```
The current meta data or null if no meta data available yet

Return:

The metadata for the given archive object

Registration by master:

master.archive.registerBeforeArchiveLoadCallback(callback: FunctionCallback);

afterArchiveLoad

Diese Funktion wird lediglich für die Anzeige von Archivdokumenten benötigt.

Wenn das Archivobjekt serverseitig geladen wurde, ruft CIB doXiview den Master mit der Funktion afterArchiveLoad auf.

Function

Parameters

Return

afterArchiveLoad

archiveObjectId: String
archiveDocumentIndex: int
metaData: String

JSON

Returns meta data for the specified archive object.

Parameter description:

```
String: archiveObjectId:
```
The id of the currently loaded archive object.
```
int: archiveDocumentIndex:
```
The current archive document index
```
String: metaData:
```
The current meta data coming from the archive system for this archive object.

Return:

The parameters object being passed into this function.

Registration by master:

master.archive.registerAfterArchiveLoadCallback(callback: FunctionCallback);