cib runshell technischer leitfaden
Werbung
> Technical Support & Services CIB RUNSHELL TECHNISCHER LEITFADEN Technical Support & Services > Stand: 30. Januar 2015 Version 3.4 CIB software GmbH > Technical Support & Services > CIB runshell > Dokument DOKUMENT TechnischerLeitfadenCibRunshell.docx, vom 30.01.2015 14:21:00 Autor: CIB software GmbH Thema: CIB runshell – Technischer Leitfaden Technical Support & Services Copyright: CIB software GmbH, Elektrastraße 6a, 81925 München Status: gültig 2 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Versionshistorie VERSIONSHISTORIE Datum Beschreibung Version 08.06.2006 Erstausgabe 1/0 10.07.2006 Überarbeitung 1/1 22.08.2006 Erweiterung 1/2 01.02.2007 Aktualisierung 1/3 06.06.2007 Aktualisierung Kommandos 1/4 30.03.2010 Überarbeitung 2/0 17.05.2010 Aktualisierung Kommandos 2/1 14.09.2010 Layout Anpassung Beschreibung des Argument „--useprintbracket“ eingefügt Beschreibung der Argumente „—help“ und „— time“ eingefügt Beschrebung deer Argumente „-LicenseCompany“, „--LicenseKey“, „-j“ und „jh“ eingefügt Einfügen Argumente -big2, -vw, -vj, –fp2 3/0 24.02.2011 20.06.2012 22.01.2013 29.07.2014 3/1 3/2 3/3 3/4 3 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Inhalt INHALT 1 ALLGEMEIN __________________________________________________________________________________ 6 1.1 Hinweis ______________________________________________________________________________________ 6 1.2 Support ______________________________________________________________________________________ 7 1.3 Literaturverweis_____________________________________________________________________________ 7 1.4 Lieferumfang ________________________________________________________________________________ 8 1.5 Lizenzierung _________________________________________________________________________________ 8 1.6 Abkürzungen_________________________________________________________________________________ 8 2 EINFÜHRUNG ________________________________________________________________________________ 9 3 INSTALLATION______________________________________________________________________________10 3.1 Windows ____________________________________________________________________________________10 3.2 Linux und Unix______________________________________________________________________________10 4 FUNKTIONSUMFANG _______________________________________________________________________11 4.1 Versionen der CIB office Module (=CoMod) ausgeben ___________________________________11 4.2 CIB office Module ansteuern_______________________________________________________________13 4.3 Besonderheiten_____________________________________________________________________________13 4.3.1 Java 5 KOMMANDOS UND PARAMETER ___________________________________________________________14 5.1 Zusatzkommando ___________________________________________________________________________22 5.2 Aufrufsyntax ________________________________________________________________________________23 5.3 Konfigurationsdatei ________________________________________________________________________23 5.3.1 Dateiformat 23 5.3.2 Namen von Sections und Keys 25 5.3.3 Beispiel für Konfigurationsdatei 27 5.4 Funktionsweise _____________________________________________________________________________27 6 SCHNELLER EINSTIEG ______________________________________________________________________28 6.1 Aufruf der native CIB runshell aus Java mit Inifile für eine CIB pdf-Konvertierung ____28 6.2 Aufrufbeispiel der CIB runshell aus Java und direkter Druck eines PDF-Dokuments ___29 6.3 CIB runshell-Beispiel: Aufruf der native CIB runshell aus Java für einen CIB mergeMischlauf____________________________________________________________________________________30 6.4 Aufrufbeispiel der CIB runshell aus Java und ausführen von IsPadAvailable ___________31 6.5 Aufrufbeispiel der CIB runshell über ein Script aus Java _________________________________32 7 ANHANG_____________________________________________________________________________________33 7.1 Returnwert und Fehlerbehandlung ________________________________________________________33 7.1.1 Returnwert 33 7.1.2 Fehlerbehandlung 33 13 4 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Inhalt 8 ABBILDUNGSVERZEICHNIS ________________________________________________________________34 5 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Allgemein 1 ALLGEMEIN 1.1 HINWEIS © Copyright 2004-2015 CIB software GmbH. Alle Rechte vorbehalten. Die CIB software GmbH behält sich sämtliche Eigentumsrechte an der angebotenen Software und der dazugehörigen Dokumentation vor. Die Benutzung der Software und des dazugehörigen Benutzerhandbuches unterliegen dem der Software zugrundeliegenden Lizenzvertrag. Die Bereitstellung und der Download dieses Dokuments und der Software allein bewirken keine Übertragung von Nutzungs- und Vervielfältigungsrechten. Kein Teil dieses Handbuchs darf ohne schriftliche Genehmigung der CIB software GmbH in irgendeiner Form reproduziert oder weiterverwertet werden. Auch eine Bearbeitung, insbesondere eine Übersetzung der Dokumentation, ist ohne Genehmigung der CIB software GmbH nicht gestattet. Der Inhalt dieses Handbuches ist auch urheberrechtlich geschützt, wenn es nicht mit der Software geliefert wird, die eine Endbenutzerlizenzvereinbarung enthält. CIB pdf brewer, CIB coSys, CIB webdesk, CIB workbench, CIB dialog, CIB merge, CIB view, CIB format, CIB print, CIB pdf toolbox sind entweder eingetragene Marken oder Marken der CIB software GmbH. Windows ist eine eingetragene Marke der Microsoft Corporation. Solaris und Java sind Marken bzw. eingetragene Marken von Oracle und ihrer Tochtergesellschaften. Alle anderen Marken- und Produktnamen sind Marken oder eingetragene Marken der jeweiligen Rechteinhaber. Der Inhalt dieses Handbuchs wurde mit größter Sorgfalt erarbeitet. Die Angaben in diesem Handbuch gelten jedoch nicht als Zusicherung von Eigenschaften des Produktes. Die CIB software GmbH haftet nur im Umfang ihrer Verkaufs- und Lieferbedingungen und übernimmt keine Gewähr für technische Ungenauigkeiten und oder Auslassungen. Die CIB software GmbH haftet weder für technische oder typographische Fehler und Mängel in diesem Handbuch, noch für Schäden, die direkt oder indirekt auf die Lieferung, Leistung und Nutzung dieses Materials zurückzuführen sind. Die Informationen in diesem Handbuch können ohne Ankündigung geändert werden. 6 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Allgemein Sollten während des Einsatzes Unstimmigkeiten in Zusammenhang mit den Ausführungen in dieser Übersicht auftreten, sind wir Ihnen für entsprechende Hinweise sehr dankbar: CIB software GmbH Elektrastraße 6a 81925 München E-Mail: [email protected] Tel.: 49 (0)89 / 1 43 60 - 111 Fax: 49 (0)89 / 1 43 60 - 100 1.2 SUPPORT E-Mail: [email protected] Tel.: 49 (0)89 / 1 43 60 - 111 Fax: 49 (0)89 / 1 43 60 - 100 1.3 LITERATURVERWEIS Dokumentationsart Titel Technische Einführung TechnischerLeitfaden_CIB_documentserver Technische Einführung TechnischerLeitfadenCIBPdfToolbox Technische Einführung TechnischerLeitfadenCIBFormatBarcode Technische Einführung TechnischerLeitfadenCIBFormatOutput Technische Einführung TechnischerLeitfadenCIBMerge Technische Einführung technischerLeitfaden_CIBJob Technische Einführung TechnischerLeitfadenCibViewForm Technische Einführung TechnischerLeitfadenCibViewSign Technische Einführung TechnischerLeitfadenCibRec Schulungsunterlage Dynamische Dokumente - Band 1 - Grundlagen Dynamische Dokumente - Band 2 – Fortgeschrittene Optionen 7 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Allgemein 1.4 LIEFERUMFANG Als Ausführbares Consolenprogramm (EXE) Komponente CIB runshell Softwareumfang WIN32 · cibrsh.exe CIB runshell, Kommandozeilenshell WIN32 Unix · cibrshux CIB runshell, Kommandozeilenshell für Unix(e) Abbildung 1 Lieferumfang CIB runshell Im Lieferumfang ist desweiteren eine Hilfe und Anwendungsbeispiele enthalten. Für die aktive Nutzung der CIB runshell müssen die zugehörigen COMod-Dlls im Zugriff sein und lizensiert sein. Zusätzlich wird eine Beispiel-Konfigurationsdatei mit ausgeliefert. 1.5 LIZENZIERUNG Dieses Dokument gibt keine Hinweise zur Lizenzierung. Detaillierte Informationen zu Lizenzierung und den Lizenzmodellen erhalten Sie von den Mitarbeitern des CIB Vertriebs. 1.6 ABKÜRZUNGEN In diesem Dokument werden folgende Abkürzungen benutzt: § § API CoMod Application Interface (=Anwendungsschnittstelle) CIB office Module § § § CSV DLL PDF comma separated values, Standardformat zur Datenübergabe Dynamic Link Library Portable Document Format § RTF § Word Rich Text Format. Leistungsfähiges, standardisiertes Dateiformat zur Beschreibung von Dokumenten. Microsoft Word 2007, 2010, 2013 8 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Einführung 2 EINFÜHRUNG Die CIB runshell ist ein komfortables Kommandozeilentool. Darüber können alle CIB office Komponenten, die in Form von DLLs oder shared libraries ausgeliefert werden, angesteuert werden. Mit der CIB runshell ist es insbesondere möglich alle Aufrufparameter ("Properties") zu setzen, die diese einzelnen CIB office Module zur Verfügung stellen. Ebenso kann über die CIB runshell mit Hilfe einer Parameterdatei ein größerer Auftrag an mehrere verschiedene CIB office Module abgesetzt werden. Die vorliegende Dokumentation gibt Ihnen einen schnellen Überblick über die Einsatzmöglichkeiten. 9 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Installation 3 INSTALLATION 3.1 WINDOWS Das Konsolenprogramm cibrsh*.exe kann als eigenständiges Programm angewendet werden und wird dazu in das Verzeichnis der COMod-Dlls kopiert. Die Konfigurationsdatei cibrsh.ini kann alternativ auch ins Windowsverzeichnis kopiert werden. Zusätzlich besteht die Möglichkeit, mit dem Parameter „–i <Pfad>cibrsh.ini“, die Konfigurationsdatei direkt anzugeben. 3.2 LINUX UND UNIX Das Konsolen-Programm cibrshux kann als eigenständiges Programm verwendet werden, dazu kopiert man es ins Verzeichnis mit den COMod-Libraries und setzt den Library-Path korrekt. Die Konfigurationsdatei cibrsh.ini kann man auch in dieses Verzeichnis kopieren oder alternativ mit dem Parameter „–i <Pfad>cibrsh.ini“ angeben. 10 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Funktionsumfang 4 FUNKTIONSUMFANG 4.1 VERSIONEN DER CIB OFFICE MODULE (=COMOD) AUSGEBEN Ohne Aufrufparameter gibt die CIB runshell Informationen über die vorgefundenen CIB office Module auf dem Bildschirm aus. Es werden dann alle CIB office Module (wie zum Beispiel CIB format, CIB view, CIB merge, CIB rec, CIB r2h, CIB dialog, jeweils Dll-Version) gesucht und die gefundenen mit Versionsnummer, Erstellungsdatum, Installationsverzeichnis und Dateigröße ausgegeben. Wenn in dem aktuellen Verzeichnis manche CIB Module nicht gefunden werden, dann wird alternativ in allen Verzeichnissen die über die (LIB)PATH Systemumgebungsvariablen zugänglich sind, nach vorhandenen CIB Modulen gesucht und diese entsprechend ausgegeben. Abbildung 2 Versionsanzeige installierte CIB office Module In Abbildung 1 sehen Sie einmal den CIB print markiert, durch den Aufruf von cibrsh.exe bekommen Sie nun folgende Informationen: CIB print(= CIB format) ist als Version 5.3.176 installiert und wurde am 03.07.2006 erstellt. Ebenso kann man die Dateigröße mit 8769591 Bytes 11 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Funktionsumfang und das Installationsverzeichnis „D:\Source\COMod\bin\Debug\“ sowie den Dateinamen CibPrt32.dll ablesen. 12 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Funktionsumfang 4.2 CIB OFFICE MODULE ANSTEUERN Mit der CIB runshell kann jede CIB office Komponente gezielt angesteuert werden. Alle über Kommandozeilenparameter und Konfigurationsdateien ansteuerbaren Funktionalitäten werden unterstützt. Alle Stringproperties, alle numerischen Properties sowie alle Flags (boolsche Properties) können konfiguriert werden. Mehrere Kommandos (auch gemischte CoMods) können mit einem einzigen Aufruf angestoßen werden, z.B. Mischen eines Dokuments mit CIB merge, Drucken des Ergebnisses mit CIB format/print sowie Konvertierung mit CIB format/pdf. Die Parameter- und Kommandoübergabe kann auch über eine Parameterdatei erfolgen. 4.3 BESONDERHEITEN Insbesondere zur Massenverarbeitung großer Multi-RTF-Dateien mit CIB format/print ist die CIB runshell eine komplett fertige und einfach einzusetzende Steuerungsmöglichkeit. Die CIB runshell unterstützt CIB format/print ab der Version 5.0.x 4.3.1 Java Ebenso lässt sich die CIB runshell gut aus Java Anwendungen nutzen. Dafür steht Ihnen eine eigene JAVA Klasse zur Verfügung. Beispiele siehe Kapitel „Schneller Einstieg“. 13 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter 5 KOMMANDOS UND PARAMETER Die nachfolgende Aufstellung zeigt alle verfügbaren Kommandos, die über die CIB runshell ausgeführt werden können. Kommando erforderliche MindestParameter Funktion Erforderliches CIB modul <kein Parameter> Entfällt Zeigt Information zu den installierten CIB Modulen an keines -a Eingabedateiname Lädt angegebene Datei und speichert sie im ASCII-Format. Der Ausgabedateiname entspricht bis auf die Dateinamenerweiterung ".txt" dem Eingabedateinamen CIB format -f Eingabedateiname Lädt Eingabedatei und speichert sie im PDF-Format. Der Ausgabedateiname entspricht bis auf die Dateinamen Erweiterung „.pdf“ dem Eingabedateinamen CIB format -fa Eingabedateiname Lädt angegebene Datei und speichert sie im PDF/A-Format CIB format -fe Eingabedateiname Lädt angegebene Datei und speichert sie im PDF-Format mit Enhanced-Objekt. (ePdf) CIB format -gj Eingabedateiname Lädt angegebene Datei und speichert sie im JPEG-Format. CIB format (ab CIB runshell Version 1.3.93 und CIB format Version 5.3.232) -gp Eingabedateiname Lädt angegebene Datei und speichert sie im PNG-Format. CIB format (ab CIB runshell Version 1.3.93 und CIB format Version 5.3.232) -gt Eingabedateiname Lädt angegebene Datei und speichert sie im TIFF-Format. CIB format (ab CIB runshell Version 1.3.93) 14 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter Kommando erforderliche MindestParameter Funktion Erforderliches CIB modul -h Eingabedateiname Lädt angegebene Datei und speichert sie im HTML-Format. Der Ausgabedateiname entspricht bis auf die Dateinamenerweiterung ".html" dem Eingabedateinamen. CIB format -l Eingabedateiname Lädt angegebene Datei und speichert sie im PCL-Format. CIB format -lp Eingabedateiname Lädt angegebene Datei und druckt sie im PCL-Format CIB format -o Eingabedateiname Sendet die angegebene Datei per Email an einen Empfänger. Optional kann eine weitere Datei angegeben werden, welche als Mailtext gesendet wird. (MAPI) CIB format -p Eingabedateiname Druckt die angegebene Datei mit CIB format CIB format\print auf dem Standarddrucker bzw. auf dem in der Konfigurationsdatei spezifizierten Drucker aus -r Eingabedateiname Ausgabedateiname Lädt Eingabedateiname und speichert sie unter dem Ausgabedateinamen im RTF-Format ab. CIB format -rf Eingabedateiname Ausgabedateiname Lädt Eingabedateiname und filtert sie unter dem Ausgabedateinamen im RTF-Format ab. (ab CIB runshell Version 1.3.91) CIB format -s Eingabedateiname Lädt angegebene Datei und speichert sie im Postscript-Format. Der Ausgabedateiname entspricht bis auf die Dateinamenerweiterung ".ps" dem Eingabedateinamen CIB format -sc Eingabedateiname Lädt angegebene Datei und führt CIB format einen SyntaxCheck in eine Textdatei durch (ab CIB runshell Version 1.3.96) 15 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter Kommando erforderliche MindestParameter Funktion Erforderliches CIB modul -sp Eingabedateiname Lädt angegebene Datei und druckt sie als Postscript-Strom. CIB format -t Eingabedateiname Lädt angegebene Datei und speichert sie im TIFF-Format. CIB format Veraltet: ab CIB runshell Version 1.3.93 siehe Parameter -gt -vw Eingabedateiname Konvertiert die Eingabedatei in CIB webView Output[png + CIB metafile]. OutputFormat=FormatWebview CIB format Eingabedateiname Konvertiert die Eingabedatei in CIB jView Output[CIB metafile] OutputFormat=FormatJavaview CIB format Eingabedateiname Lädt Eingabedateiname und alle CIB format enthaltenen Feldinformationen werden im Ausgabedateinamen gespeichert. (rtf-name;rtf-field;fieldparam) Ist kein Ausgabedateiname angegeben, wird <Eingabedateiname>.DAT verwendet. (Ab Version 1.7) -vj (Ab Version 1.7) -xf optional: Ausgabedateiname -xfo Eingabedateiname Lädt angegebene Datei und speichert sie im XSL-FO-Format. (ab CIB runshell Version 1.3.90a) CIB format -v Eingabedateiname Zeigt CIB view Druckvorschau der angegebenen Datei. CIB view CIB format/output CIB pdf toolbox -vp Eingabedateiname Silent Druck der angegebene PDF Datei CIB pdf toolbox CIB view -vi Eingabedateiname Zeigt die angegebene Datei im CIB image an. CIB image -m Parameterdateiname Verwendet angegebene Datei als Parameterdatei und startet CIB merge CIB merge 16 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter Kommando erforderliche MindestParameter m<Parameter> -xm Eingabedateiname optional: Ausgabedateiname Funktion Erforderliches CIB modul Führt CIB merge mit dem angegebenen Merge Parameter aus. CIB merge Lädt Eingabedateiname und alle CIB merge enthaltenen Feldinformationen werden im Ausgabedateinamen gespeichert. (rtf-name;rtf-field;fieldparam) Ist kein Ausgabedateiname angegeben, wird <Eingabedateiname>.DAT verwendet. -fb Eingabedateiname Lädt druckbare Datei und speichert sie im PDF-Format. CIB pdf brewer -fb Eingabedateiname Ausgabedateiname Lädt druckbare Datei1 und speichert CIB pdf brewer sie im PDF-Format unter Datei2 ohne den Speichern Unter-Dialog anzuzeigen. -fb * Frägt nach Datei und speichert sie im PDF-Format. CIB pdf brewer -fbc ... Frägt nach Datei und speichert sie im PDF-Format, verwendet jedoch die aktuellen Druckeinstellungen. CIB pdf brewer -fbs * zeigt die aktuellen Druckeinstellungen und speichert diese. CIB pdf brewer -tb Eingabedateiname Lädt druckbare Datei und speichert sie im TIFF-Format. CIB tiff brewer -tb Eingabedateiname Ausgabedateiname Lädt druckbare Eingabedateiname und speichert sie im TIFF-Format unter Ausgabedateiname ohne den „Speichern unter“-Dialog anzuzeigen. CIB tiff brewer -tb * Frägt nach Datei und speichert sie im TIFF-Format. CIB tiff toolbox -tbc ... Lädt druckbare Datei und speichert sie im TIFF-Format verwendet jedoch die aktuellen Druckeinstellungen. CIB tiff toolbox 17 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter Kommando erforderliche MindestParameter Funktion Erforderliches CIB modul Zeigt die aktuellen Druckeinstellungen und speichert diese. CIB tiff toolbox Eingabedateiname1 Eingabedateiname2 Ausgabedateiname "CIB pdf join": CIB pdf toolbox Eingabedateiname Ausgabedateiname "CIB pdf merge": Eingabedateiname Druck einer PDF-Datei CIB pdf toolbox Eingabedateiname Öffnet den Print Setup Dialog vor dem PDF-Druck CIB pdf toolbox -oc Eingabedateiname Erkennt enthaltene Barcodes in der angegebenen Datei und liefert als BarcodeFilename-Property Wert auf stdout zurück. (ab CIB runshell Version 1.3.89) CIB ocr -om keine Sendet Emails über die Windows MAPI an Empfänger. CIB mail -os keine Sendet Emails über SMTP an Empfänger. CIB mail -c Eingabedateiname Verschlüsselungs- und Komprimierungsfunktionen. CIB crypt -cd Eingabedateiname Ausgabedateiname Lädt Eingabedateiname und entschlüsselt sie. Das Ergebnis wird unter dem Ausgabedateinamen gespeichert. CIB crypt -tbs * -fj -fm -fp Lädt die angegebenen PDF-Dateien, und speichert sie im PDF-Format unter Datei3 zusammen ab. CIB pdf toolbox Lädt angegebene PDF-Datei, aktualisiert die Werte der Kontrollfelder und speichert sie im PDF-Format unter Datei2 (Ab Version 1.3.84) -fp2 (Ab Version 1.7) 18 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter Kommando erforderliche MindestParameter Funktion Erforderliches CIB modul -ce Eingabedateiname Ausgabedateiname Lädt Eingabedateiname und verschlüsselt sie. Das Ergebnis wird unter dem Ausgabedateinamen gespeichert. CIB crypt Entschlüsselt/Entkomprimiert Datei1 und speichert sie verschlüsselt/komprimiert in Datei2 <format>=(CC9|RC4|D3DES|ZLIB)* CIB crypt [InputFormat =<format>] -c Datei1 Datei2\n -d Eingabedateiname Lädt angegebene Job-Datei und führt CIB job die darin definierten Arbeitsschritte aus. -d Eingabedateiname Ausgabedateiname Führt die XMLAuftragsdatei(Eingabedateiname) aus und speichert die Autragsergebnisdatei unter dem Ausgabedateinamen. CIB job -df Eingabedateiname Ausgabedateiname Führt die XMLAuftragsdatei(Eingabedateiname) aus und speichert die Autragsergebnisdatei Autragsergebnisdatei unter dem Ausgabedateinamen und verwendet das Filename-Interface. CIB job -dm Eingabedateiname Ausgabedateiname Führt die XMLAuftragsdatei(Eingabedateiname) aus und speichert die Autragsergebnisdatei unter dem Ausgabedateinamen und verwendet das InputMemoryAdress-Interface. CIB job -fd Eingabedateiname Extrahiert die eingebettete(n) Datei(en) aus dem CIB e.Pdf. CIB epdf -fi Eingabedateiname Liest die Info der PDF-Datei mit Enhanced-Object. (ePdf) CIB epdf Prüft ob ein SignaturPad angeschlossen ist. CIB pad Vergleicht die Eingabedateien miteinander. CIB compare -ua -j Eingabedateiname1 Eingabedateiname2 19 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter Kommando erforderliche MindestParameter Funktion -jh Eingabedateiname1 Eingabedateiname2 Vergleicht die HOCR Eingabedateien CIB compare miteinander. -jbig Eingabedateiname1 Eingabedateiname2 Wandelt eine jbig2 in bmp um. CIB jbig2 Eingabedateiname CIB jsMerge Ausgabedateiname Ansteuerung CIB jsMerge: verarbeitet Eingabedatei und darin enthaltene Befehle und gibt Ausgabedatei aus Entfällt Führt den CIB install cleaner aus CIB install cleaner -i Dateiname Verwendet angegebene Datei als Konfigurationsdatei - = Propertyname=Wert Weist der Property "Propertyname" den Wert "Wert" zu. - -? Entfällt Zeigt eine Hilfeseite in der Konsole an - --help Entfällt Zeigt eine Hilfeseite in der Konsole an - Setzt Property A auf den Wert B für das nächste Kommando. - (Ab Version 1.7) -js -e Erforderliches CIB modul (Ab Version 1.3.84) (ab CIB runshell Version 1.4.98) A=B 20 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter Kommando -z erforderliche MindestParameter Funktion Erforderliches CIB modul Setze die Prozesspriorität. Beispiel - z-1 Folgende Prozessor-Prioritäten bestehen unter Windows: -2, -1, 0, 1, 2 für idle, niedrig, normal, höher, hoch Folgende Prozessor-Prioritäten bestehen unter Unix: 20, ..., -20 für sehr niedrig bis sehr hoch Eine Erhöhung der Priorität ist nur mit root-Rechten möglich. Abbildung 3 Kommandoübersicht 21 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter 5.1 ZUSATZKOMMANDO Die nachfolgende Aufstellung zeigt alle verfügbaren Zusatzkommandos, die über die CIB runshell ausgeführt werden können. Zusatzkommando Funktion -3 Für das nächste Kommando wird das JobInterface verwendet -4 Es werden alle Operationen intern ohne Dateien im Speicher durchgeführt. -5 Es werden alle Parameter außer den Kommandos verschlüsselt erwartet. --verbose Ausgabe von Meldungen (stdout/stderr) ein-/ausschalten (ab CIB runshell Version 1.3.83) mögliche Werte: „0“ (default) - Ausgaben ausschalten „1“ - Ausgabe einschalten --no-iniwrite Ausgaben in das Ini-File ein-/abschalten (ab CIB runshell Version 1.3.86) mögliche Werte: „0“ (default) - Ausgabe einschalten „1“ - Ausgabe abschalten --batch-error-mode Abbruch, wenn in mehreren Aufrufen in einer Zeile ein Rückgabewert ungleich „0“ aufgetreten ist. (ab CIB runshell Version 1.3.86) mögliche Werte: „ignore“ (default) - kein Abbruch des Aufrufs bei Fehler „fail“ - Abbruch des Aufrufs bei Fehler --module-dir Nach Angabe eines Verzeichnisses zu den Modulen(Libraries) werden diese für die weiteren Argumente verwendet. (ab CIB runshell Version 1.3.88) --use-printbracket Durch Angabe des Argumentes erfolgt der Druck über CIB format oder CIB pdf toolbox in einer Druckklammer. (ab CIB runshell Version 1.3.93) --time Ausgabe der genutzten Systemressource auf stdout zum aktuell durchgeführten Aufruf (ab CIB runshell Version 1.4.98) --LicenseCompany= <license> Setzen des Lizenznehmer einer CIB runshell Lizenz (ab CIB runshell Version 1.6.0) --LicenseKey=<key> Setzen des Lizenzschlüssels einer CIB runshell Lizenz (ab CIB runshell Version 1.6.0) 22 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter 5.2 AUFRUFSYNTAX Allgemein gilt für den Aufruf der CIB runshell folgende Syntax: cibrsh.exe [<Propertyname>=<Wert>] [-<Zusatzkommando>] [-<Kommando1> <Dateiname> [<Dateiname>]] [<Propertyname>=<Wert>] [-<Kommando2> <Dateiname> [<Dateiname>]] ... Ein Aufruf der CIB runshell besteht immer aus Property-Optionen und der Kommandooption (z.B. "– p") sowie keinem, einem oder zwei Dateinamen, je nach Kommando. Die Property-Optionen und die Dateinamen können auch in einer Konfigurationsdatei abgelegt werden. Dann wird die CIB runshell mit der Kommandooption „-i“ und Angabe der Konfigurationsdatei aufgerufen. Mit der CIB runshell können mehrere Kommandos in einem Aufruf nacheinander ausgeführt werden. Ruft man die CIB runshell ohne ein Argument auf, führt dies zur Ausgabe der verfügbaren CIB office Module und deren Versionsprüfung. 5.3 KONFIGURATIONSDATEI 5.3.1 Dateiformat Die Konfigurationsdatei ist eine Textdatei. Die Informationen werden im INI-Dateiformat abgelegt, d.h. die Datei enthält Überschriften in eckigen Klammern, sogenannte Sektionen (=Sections) zu denen dann Texte unter einem Namen(=Key) und deren Wert(=Value) abgelegt werden. 5.3.1.1 Abbildung der Property-Typen Typ Text in Konfigurationsdatei Beispiel Text Der Text ohne umschließende Anführungszeichen, auch wenn Leerzeichen enthalten sind. Pfadangaben kommen mit den systemspezifischen Pfadtrennern aus, also / unter Unix, \ unter Windows/OS2 PrinterName=\\SERVER1\Fiery SI Copier Zahl Die Zahl wird im Dezimalsystem als Text angegeben. YResolution=600 23 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter Typ Text in Konfigurationsdatei Beispiel Flag Boolsche Properties, deren Wert "falsch" ist, können als 0 oder als FALSE angegeben werden. Soll "wahr" als Propertywert angegeben werden, so kann 1, TRUE oder ein beliebiger anderer, nichtleerer Text angegeben werden außer 0 und FALSE. FontsEmbedded=TRUE Farbe Farben, wie sie für CIB view und CIB format/html angegeben werden können, müssen im Farbenformat des Betriebssystems angegeben werden. Windows: lt. Makro RGB(r,g,b) als 4-Byte-Zahl, Byte3=0, Byte2=b, Byte1=g, Byte0(LSB)=r. Die entstehende Ganzzahl ist im Dezimalsystem anzugeben. CVWFocusColor=8421376 Anmerkung: Dies entspricht r=0, g=128, b=128 (Dunkles Blaugrün). Das ergibt sich aus: 128 = (hex)80, Blaugrün = (hex)00 80 80 00 = (dez)8421376 24 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter 5.3.2 Namen von Sections und Keys Die Namen der Sections in der ini-Datei richten sich nach den CIB office Modulen, deren Properties gesetzt werden sollen. Die Namen der Key sind die Strings, die zur Bezeichnung der Properties in der zugehörigen Headerdatei (.h) definiert sind. [section] key = <value> Modul Sectionname Headerdatei Beispiel CIB format [Print] PrinterName=\\SERVER1\Fiery SI Copier Für 5.2/5.3: Comod.h cibprt.h Für CIB format 5.1 Comod.h CPRPrinterName=\\SERVER1\Fiery SI Copier Für CIB format 5.0: OldPrt50.h Bzw.: cib_prt.h CIB view [View] CibVw.h CVWTitleString=”CIB software Viewer” CIB merge CIB merge unterstützt noch keine Properties. Bitte alle Einstellungen wie gewohnt über die Parameterdatei treffen. CIB shape [Print] CIB rec [Rec] 25 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter Modul Sectionname Headerdatei CIB pdf toolbox [Pdftoolbox] CibPdf.h CIB job [Job] CIB image [Image] CIB epdf [EPdf] CIB diff [CIB diff] CIB crypt [Crypt] Beispiel COMod.h In Entwicklung CIB compar [Compare] e In Entwicklung CIB chart [Chart] Wird nie direkt aufgerufen CIB tiff brewer API [CIB tiff brewer] CIB pdf brewer API [CIB pdf brewer] CIB mail [Mail] COMod.h MailSenderFullName="CIB support" [email protected] CIB runshell [Runshell] --verbose=1 Abbildung 4 Sektionen in Konfigurationsdatei 26 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Kommandos und Parameter 5.3.3 Beispiel für Konfigurationsdatei Das Beispiel legt einen anderen Drucker als den Standarddrucker für CIB format/print fest. Diese Einstellung gilt auch für CIB view, da CIB view die CIB format-Einstellung verwendet. Außerdem werden Lizenzdaten gesetzt. Datei cibrsh.ini im Windowsverzeichnis: [Print] ;Print 51 PrinterName=\\SERVER1\Fiery SI Copier-M v2015.108 QMS ; Print 50/16bit CPRPrinterName=\\SERVER2\HPLASERJET4 LicenseCompany=CIB ;Testlizenz LicenseKey=02450503630 [View] CVWTitleString=CIB software Viewer 5.4 FUNKTIONSWEISE Folgende Abarbeitung der Aufrufparameter findet durch die CIB runshell statt: Die CIB runshell setzt zunächst alle für das angegebene Kommando notwendigen Properties(das sind: Eingabedateiname, ggf. Ausgabedateiname und Ausgabeformat sowie weitere). Dann werden in der Windowsversion alle in der Registry festgelegten Properties ausgewertet. Dabei werden die Einträge unter „HKEY_CURRENTUSER\Software\CIB software GmbH“ ausgelesen. Nun werden für alle Betriebssysteme die Properties aus der Konfigurationsdatei(Ini-Datei) und anschließend die in der Kommandozeile festgelegten Properties gesetzt. Mit diesen Einstellungen wird dann das angegebene Kommando ausgeführt. 27 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Schneller Einstieg 6 SCHNELLER EINSTIEG 6.1 AUFRUF DER NATIVE CIB RUNSHELL AUS JAVA MIT INIFILE FÜR EINE CIB PDF-KONVERTIERUNG package de.cib.sample.comod; import de.cib.comod.RunshellProcess; boolean doRunshellProcess() { //RunshellProcess mit dem Executable erstellen RunshellProcess cibRunShell = new RunshellProcess("cibrsh.exe"); //Eingabefilename String inputFileName = new String("Test.rtf"); //Ausgabefilename String uniqueID = ""+System.currentTimeMillis(); String outputFile = uniqueID+".pdf"; //Property für das Arbeitsverzeichnis im CIB-Format //(z.B. für IncludePicture-Anweisungen) setzen String sWorkspace = new String("c:\\test\\"); cibRunShell.addProperty("WorkSpace", sWorkspace); //IniFile mit dem Kommando -i setzen cibRunShell.addCommand("-i", sWorkspace+"cibrsh.ini"); //Kommando -f für die PDF-Konvertierung und Eingabe- sowie //Ausgabefilenamen setzen cibRunShell.addCommand(RunshellProcess.COMMAND_PDF, inputFileName, outputFile); try { //PDF-Konvertierung ausführen cibRunShell.executeAndWait(new File(sWorkspace)); } catch(Exception ex) { System.out.println("Bei der Konvertierung mit CIB format "+ "ist eine Exception aufgetreten."); return false; } //Fehlerbehandlung der Runshell int error = cibRunShell.getExitCode(); if (error != 0) { System.out.println("CIB format-Fehler: " + error + "bei der Ausführung von " + cibRunShell.getCommandLine() + ";"); return false; } return true; } 28 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Schneller Einstieg 6.2 AUFRUFBEISPIEL DER CIB RUNSHELL AUS JAVA UND DIREKTER DRUCK EINES PDF-DOKUMENTS Um diese Beispiel auszuführen werden zwei weitere Klassen benötigt: RunshellProcess.java und Process.java . import java.io.*; import de.cib.comod.RunshellProcess; public class DirectPrintPdf { public static void main(String[] args) { //PDF-Datei festlegen z.B. ein Test.pdf String inputFileName = new String("..\\Test.pdf"); // neuen Runshell-Prozess starten RunshellProcess cibRunShell = new RunshellProcess("cibrsh.exe"); //Druckernamen festlegen z.B. HP LaserJet 4100 Series PS cibRunShell.addArgument("PrinterName = \\\"" + "HP LaserJet 4100 Series PS" + "\\\""); //Ausgabeformat festlegen cibRunShell.addProperty("OutputFormat", "FormatPrinter"); //Eingabedatei festlegen cibRunShell.addCommand(RunshellProcess.COMMAND_PDFJOIN, inputFileName); try { //Pfad zu den Libraries angeben und Prozess starten runshell.executeAndWait(new File(".")); } catch(IOException io) { io.printStackTrace(); } catch(InterruptedException inter) { inter.printStackTrace(); } } 29 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Schneller Einstieg 6.3 CIB RUNSHELL-BEISPIEL: AUFRUF DER NATIVE CIB RUNSHELL AUS JAVA FÜR EINEN CIB MERGE-MISCHLAUF package de.cib.sample.comod; import de.cib.comod.RunshellProcess; boolean doMergeRunshellProcess() { // neuen Runshell-Prozess starten String t_Workspace = new String("\home\user\"); // cibrshux ist die CIB runshell unter Linux/Unix RunshellProcess runshell = new RunshellProcess("./bin/cibrshux"); runshell.addArgument(RunshellProcess.COMMAND_MERGE+"a./templates"); runshell.addArgument(RunshellProcess.COMMAND_MERGE+"q./Data"); runshell.addArgument(RunshellProcess.COMMAND_MERGE+"'l!merge.log'"); runshell.addArgument(RunshellProcess.COMMAND_MERGE+"iTest.rtf"); runshell.addArgument(RunshellProcess.COMMAND_MERGE +"'o!output.rtf'"); runshell.addArgument(RunshellProcess.COMMAND_MERGE+"s"); runshell.addArgument(RunshellProcess.COMMAND_MERGE+"-oldcompare"); runshell.addArgument(RunshellProcess.COMMAND_MERGE+"dTest.csv"); runshell.addArgument(RunshellProcess.COMMAND_MERGE+"@1"); try { // Pfad zu den Libraries angeben und Prozess starten runshell.executeAndWait(new File(t_Workspace)); } catch(IOException io) { System.out.println("Beim Mischen mit CIB merge "+ "ist eine Exception aufgetreten."); return false; } catch(InterruptedException inter) { System.out.println("Beim Mischen mit CIB merge "+ "ist eine Exception aufgetreten."); return false; } // Fehlerbehandlung der CIB runshell int error = cibRunShell.getExitCode(); if (error != 0) { System.out.println("CIB merge-Fehler: " + error + "bei der Ausführung von " + cibRunShell.getCommandLine() + ";"); return false; } return true; } 30 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Schneller Einstieg 6.4 AUFRUFBEISPIEL DER CIB RUNSHELL AUS JAVA UND AUSFÜHREN VON ISPADAVAILABLE Um diese Beispiel auszuführen werden zwei weitere Klassen benötigt: RunshellProcess.java und Process.java . import java.io.*; import de.cib.comod.RunshellProcess; public class PadAvailable { public static void main(String[] args) { // neuen Runshell-Prozess starten RunshellProcess runshell = new RunshellProcess("cibrsh.exe"); runshell.addCommand("-ua", ""); try { //Pfad zu den Libraries angeben und Prozess starten runshell.executeAndWait(new File(".")); } catch(IOException io) { io.printStackTrace(); } catch(InterruptedException inter) { inter.printStackTrace(); } //Wenn der ExitCode 0 ist wurde ein Pad gefunden if (runshell.getExitCode() != 0) { System.out.println("no pad available"); System.out.println("exit with code " + runshell.getExitCode()); } else { System.out.println("pad found"); } } } PadAvailable.java 31 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Schneller Einstieg 6.5 AUFRUFBEISPIEL DER CIB RUNSHELL ÜBER EIN SCRIPT AUS JAVA import java.lang.Runtime; import java.io.*; import java.lang.*; public class ScriptExec { public static void main(String[] args){ System.out.println("start"); // TODO implement Main.main Runtime t_RunTime = Runtime.getRuntime(); if (t_RunTime != null) { String[] t_cmdarray = new String[2]; //Angabe das aufzurufenden Scripts t_cmdarray[0] = new String("./TestScript.sh"); //Argument fuer das Script mit Leerzeichen t_cmdarray[1] = new String("DocInfo.Author=CIB support Team"); try { //Script starten Process t_Process = t_RunTime.exec(t_cmdarray); int t_Result = t_Process.waitFor(); } catch (IOException exec) { System.out.println("IOException"); exec.printStackTrace(); } catch (InterruptedException interexec) { System.out.println("InterruptedException"); interexec.printStackTrace(); } } } } ScriptExec.java #/bin/sh LD_LIBRARY_PATH=. ./cibrshux "$1" -f input.rtf output.pdf TestScript.sh aus Linux/Unix 32 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Anhang 7 ANHANG 7.1 RETURNWERT UND FEHLERBEHANDLUNG 7.1.1 Returnwert Der Errorlevel/Exitcode des EXE-Aufrufs entspricht dem Fehlercode des ausgeführten Moduls bzw. dem Fehlercode des Betriebssystems. Zum Beispiel wenn das notwendige Modul nicht geladen werden konnte oder fehlt, bekommt man unter WIN32 den Rückgabewert 126. Der Rückgabewert 198 ist für jede Art von unerwarteter Ausnahme reserviert, die während der Ausführung des Befehls auftritt(zum Beispiel ein Absturz in der CIB print-Dll). 7.1.2 Fehlerbehandlung Aufgetretene Fehler werden mit der Fehlernummer und dem Fehlertext auch in der Konsole ausgegeben. Ein Fehlercode größer 0 bedeutet, daß ein Problem aufgetreten ist und das Kommando nicht ordentlich zu Ende geführt wurde. Nachfolgende Kommandos werden nicht ausgeführt, wenn bei einem Kommando ein Fehler aufgetreten ist. Konsultieren Sie zur Fehlerbehebung die entsprechenden Abschnitte der Dokumentation des aufgerufenen Moduls. 33 | 34 CIB software GmbH > Technical Support & Services > CIB runshell > Abbildungsverzeichnis 8 ABBILDUNGSVERZEICHNIS Abbildung 1 Lieferumfang CIB runshell.......................................................................................... 8 Abbildung 2 Versionsanzeige installierte CIB office Module......................................................... 11 Abbildung 3 Kommandoübersicht ................................................................................................ 21 Abbildung 4 Sektionen in Konfigurationsdatei ............................................................................. 26 34 | 34
