CIB doXiview - Integration

Die Kommunikationsschnittstellen

Das print Interface

Allgemein
getPrinterList
startPrint
openPrintDialog

Allgemein

Im Unternehmensumfeld kann CIB doXiview zusammen mit einem auf dem Arbeitsplatzrechner befindlichen Gerätedienst-Server zusammenarbeiten. Dieser kann Dienste außerhalb der Browser-Sandbox bereitstellen, um direkt über das Betriebssystem mit Geräten wie z. B. Druckern kommunizieren zu können. Auf diese Weise kann ein in CIB doXiview angezeigtes Dokument in Originalqualität gedruckt werden.

Das Interface print enthält die daran beteiligten Funktionen.

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

getPrinterList

Diese Funktion wird lediglich für das Drucken von Dokumenten über einen lokalen Gerätedienst benötigt.

Wenn über einen lokalen Gerätedienst gedruckt werden soll und der Benutzer in CIB doXiview den entsprechenden Druckdialog öffnet, wird ihm eine Liste der zur Verfügung stehenden Drucker angezeigt.

Diese Liste erfragt CIB doXiview über die Funktion getPrinterList von der Master-Anwendung. Das Besorgen dieser Liste vom lokalen Gerätedienst ist Aufgabe des Masters.

Zur Ermittlung der Drucker übergibt CIB doXiview einen Kontext als Parameter. Dieser Kontext wurde beim Start von CIB doXiview über den Startparameter webview.context hinterlegt und von dem Viewer durchgereicht.

Function

Parameters

Return

getPrinterList

printContext: String
callback: ResultCallback

JSON

Returns a list of available printers.

Parameter description:

String: printContext:

The context being used, e.g. DVS, ARC.

Return:

A JSON representation of the available printers which has the following structure:

{
          printers :
          [{
                 name: "printer 1",
               displayName: "PrinterName (location)",
                deviceServiceIP: "10.8.110.1",
                status: "Im Leerlauf",
                comment: "Kommentar a",
                location: "Raum A1 Gang 2",
                type: "printer type"
        }, {
                name: "Microsoft XPS Document Writer",
                displayName: "Microsoft XPS Document Writer (Raum A1 Gang 2)",
                deviceServiceIP: "127.0.0.1",
                status: "Im Leerlauf",
                comment: "Kommentar b",
                location: "Raum A1 Gang 2",
                type: "Microsoft XPS Document Writer"
        }],
        lastSelectedPrinterIndex:
  1 
}

Registration by master:

master.print.registerGetPrinterListCallback(callback: FunctionCallback);

startPrint

Diese Funktion wird lediglich für das Drucken von Dokumenten über einen lokalen Gerätedienst benötigt.

CIB doXiview informiert über startPrint die Master-Anwendung, wenn der Benutzer in dem Druckdialog mit der Schaltfläche Ok betätigt und der Druckvorgang gestartet werden soll.

Der Master delegiert daraufhin den Druckvorgang an den Master.

Function

Parameters

Return

startPrint

data: JSON
callback: JSON

void

Executes the printing process for the specified print data.

Parameter description:

JSON: data:

Information about the document which should be printed.

Example structure:

{
          printer: "Microsoft XPS Document Writer",
          deviceServiceIP: "127.0.0.1",
          undIds: ["1231435543645647567567", "234234324234234234"],
          context: "the print context, e.g. “ARC” for “archive”",
          options: "print options such as number of copies”
          jobName: "1234 - Test Formular"
  }

Registration by master:

master.print.registerPrintCallback(callback: FunctionCallback);

openPrintDialog

Diese Funktion wird lediglich für das Drucken von Dokumenten über einen lokalen Gerätedienst benötigt.

CIB doXiview bietet die Funktion openPrintDialog an, mit welcher der Master das Öffnen des Druckdialogs in CIB doXiview veranlassen kann.

Function

Parameters

Return

openPrintDialog

N/A

void

Used to start printing from outside of doXiview. This will prompt CIB doXiview to open the print dialog. After that, the user must press the Ok button on the print dialog to complete printing.

It is required that CIB doXiview was has been started with parameter externalPrint=true

Registration by slave:

slave.print.registerOpenPrintDialogCallback(callback: FunctionCallback);

Hinweis: In der Testoberfläche kann dieser Aufruf wie folgt ausgelöst werden:

Öffnen Sie CIB doXiview im Modus DVS
Klicken Sie in dem Bereich Basic Parameters die Schaltfläche Add Entry und fügen Sie externalPrint und true als Startparameterwerte ein.
Klicken Sie auf dem Reiter Runtime Manipulation auf die Schaltfläche Print.