Konverter anlegen

In der Grundkonfiguration sind bereits eine Vielzahl an Konvertern enthalten, mit denen Sie Dokumentformate umwandeln können.

Sie können beliebig weitere Konverter anlegen. Dabei wird zwischen unterstützten und nicht unterstützten Dokumentformaten unterschieden und ob ein Konverter, etwa Office, verwendet wird, der auf einem Windows-Server ausgeführt werden muss, agorum core selbst aber auf einem Linux-Server läuft.

Handelt es sich um nicht unterstützte Dokumentformate, müssen Sie einen eigenen Konverter verwenden, den Sie als ein Skript in Form einer .sh/.bat-Datei hinterlegen müssen. Dieses erhält als Übergabe das Quellformat und gibt als Ergebnis das Zielformat aus.

Wird agorum core auf einem Linux-Server betrieben und es sollen etwa Office-Dokumente konvertiert werden, für die auf Linux kein Konverter zur Verfügung steht, müssen Sie diese auf dem externen Server (auf dem auch die OCR installiert ist) konvertieren und zurückgeben.

Möchten Sie eine Dokumentenkonvertierung anlegen, die von einem der vorhandenen Konverter durchgeführt werden kann, müssen Sie kein Skript erstellen und die Konfiguration nicht registrieren. In diesem Fall lesen Sie ab Konverterdefinition erstellen weiter.

Im folgenden Beispiel legen Sie ein DocumentService-Konverter für das Konvertieren von JPGs in PDFs an, wobei Sie ein eigenes Skript verwenden.

Das Konvertierungsskript anlegen

1. Legen Sie das Konvertierungsskript unter folgendem Pfad an:

   <InstallDir>/jboss/server/default/deploy/roi.ear/documentservice/scripts

2. Geben Sie im Skript die folgenden Default-Parameter an:
   
   • Pfad zur Quelldatei
   • Pfad zur Zieldatei (inklusive Endung)

Die Konverterkonfiguration registrieren

Anschließend müssen Sie eine Konverterkonfiguration anlegen und registrieren. Darin ruft das System einen Konverter auf, der in der Lage ist, ein JPG-Bild in ein PDF zu wandeln. Hier wurde mit ImageMagick erfolgreich getestet.

Die Konverterklasse wird somit als ExecuteConverterWithFile angegeben, zusammen mit einer Konfiguration, die zu einem Shell-Skript führt, das als Parameter 1 ein JPG-Bild erhält und als Parameter 2 die generierte PDF-Datei. 

1. Öffnen Sie in der Seitenleiste Administration und dann MetaDB.
2. Öffnen Sie den Pfad:

   MAIN_MODULE_MANAGEMENT/documentservice/control/services/settings/
   

3. Wählen Sie im Kontextmenü Neu > MetaDb Property-Bundle anlegen.
4. Legen Sie den Ordner mit dem Namen des Konverters an:

   convertjpg2pdf

5. Legen Sie unter dem Ordner convertjpg2pdf den Unterordner Windows oder Unix an, je nachdem, wo agorum core installiert ist.
   
   Ergebnis: Der vollständige Pfad lautet jetzt:
   
   Für Unix

   /MAIN_MODULE_MANAGEMENT/documentservice/control/services/settings/convertjpg2pdf/Unix
   

   Für Windows

   /MAIN_MODULE_MANAGEMENT/documentservice/control/services/settings/convertjpg2pdf/Windows
   

Das Property-Entry „Executable“ anlegen

1. Wählen Sie im obigen Pfad (Windows oder Unix) im Kontextmenü Neu > MetaDb Property-Entry anlegen.
2. Legen Sie den Eintrag Executable mit folgendem Wert an (Pfad zum Skript):

   ${base_path_textindex}/scripts/convertJPG2PDF.sh

3. Speichern Sie die Konfiguration.

Das Property-Entry „ExecutePath“ anlegen (optional) 

1. Wählen Sie im obigen Pfad (Windows oder Unix) im Kontextmenü Neu > MetaDb Property-Entry anlegen.
2. Legen Sie den Eintrag ExecutePath mit folgendem Wert an (Pfad, wo das Skript ausgeführt wird):

   ${base_path_textindex}/scripts

3. Speichern Sie die Konfiguration.

Das Property-Entry „Parameters“ anlegen

1. Wählen Sie im obigen Pfad (Windows oder Unix) im Kontextmenü Neu > MetaDb Property-Entry anlegen.
2. Legen Sie den Eintrag Parameters mit folgendem Wert an (Parameter für das aufzurufende Programm (Array)):

   ${InputFile}
   ${OutputFile}

3. Speichern Sie die Konfiguration.

Die Konverterdefinition erstellen

/MetaDb/MAIN_MODULE_MANAGEMENT/documentservice/control/services/[ RemoteDocumentConverter ]

remoteConvertJPG2PDF

 So erstellen Sie eine Konverterdefinition:

1. Öffnen Sie in der Seitenleiste Administration und dann MetaDB.
2. Öffnen Sie den Pfad:

   MAIN_MODULE_MANAGEMENT/documentservice/control/services/[ DocumentConverter ]

3. Wählen Sie im Kontextmenü Neu > MetaDb Property-Bundle anlegen.
4. Legen Sie das Property-Bundle mit dem Namen des Konverters an:

   convertJPG2PDF

5. Ergebnis: Der vollständige Pfad lautet jetzt:

   MetaDb > MAIN_MODULE_MANAGEMENT/documentservice/control/services/[ DocumentConverter ]/convertJPG2PDF

Das Property-Entry „class“ anlegen

1. Wählen Sie im obigen Pfad im Kontextmenü Neu > MetaDb Property-Entry anlegen.
2. Legen Sie den Eintrag class mit folgendem Wert an (zu nutzender Konverter oder Verweis auf Konvertierungsskript):

   agorum.documentservice.server.impl.ExecuteConverterWithFile

3. Speichern Sie die Konfiguration.

Das Property-Entry „ParameterNames“ anlegen

1. Wählen Sie im obigen Pfad im Kontextmenü Neu > MetaDb Property-Entry anlegen.
2. Legen Sie den Eintrag ParameterNames mit folgenden Werten an (Bezeichnungen der Parameter):

   InputFileExtension
   OutputFileExtension
   ProgramSettings

3. Speichern Sie die Konfiguration.

Das Property-Entry „ParameterValues“ anlegen

1. Wählen Sie im obigen Pfad im Kontextmenü Neu > MetaDb Property-Entry anlegen.
2. Legen Sie den Eintrag ParameterValues mit folgenden Werten an (Werte zu den Bezeichnungen; unter ProgramSettings wird die registrierte Konverterkonfiguration eingetragen):

   jpg
   pdf
   convertjpg2pdf

3. Speichern Sie die Konfiguration.