Seitenhistorie
Der Java-Client(EOMS-Input) ist ein in der Programmiersprache Java entwickelter Einlieferungs-Client, welcher als Kommandozeilen-Programm in bestehende Systeme eingebunden werden kann. Die einfachste Form der Nutzung ist der Aufruf des Java-Clients(EOMS-Input) über Batch oder Script-Dateien. Unter allen Plattformen auf welchen Java installiert ist, kann über den nicht grafischen Java-Client(EOMS-Input) von der Kommandozeile des Betriebssystems eine Datenübertragung in das docxworld-System erfolgen.
Arbeitsweise
Der Voraussetzung für den Start des Java-Client(EOMS-Input) ist:
- die Verfügbarkeit eines JAVA JRE ab der Version 1.6 auf dem Server wo der Java-Client ausgeführt wird
kommuniziert nach dem Start mit dem docxworld-Input-Server auf zwei Wegen:
- über einen Kommunikations-Kanal
- über einen Daten-Kanal
Über den Kommunikations-Kanal tauschen sich der
...
Java-Client(EOMS-Input)
...
- eine korrekt definierte Konfigurationsdatei 'eoms.input.client.properties' des Java-Clients(EOMS-Input)
Konfigurationsdatei für den Java-Clients(EOMS-Input)
Die Konfiguration befindet sich in der Datei 'eoms.input.client.properties', welche im gleichen Verzeichnis abgelegt sein muss, aus welchem der Java-Clients(EOMS-Input) gestartet wird. Diese Konfigurationsdatei entspricht im Aufbau einer WIKIPEDIA - JAVA-Properties-Datei.
Folgende Einträge sind in dieser Konfigurationsdatei enthalten:
Eintrag | Wert | Beschreibung |
---|---|---|
eoms.input.service.host | xxx.xxx.xxx.xxx | Die IP-Adresse oder der Host-Name des Servers auf welchem das R-S arbeitet |
eoms.input.service.port | 8080 | Ist der TCP/IP-Port unter welchem das R-S mit entfernten Applikationen kommuniziert. |
eoms.input.user | admin | Ist der Nutzer-Name des System-Admininistrators des R-S (standardmäßig 'admin') |
eoms.input.password | admin | Ist das Passwort des System-Admininistrators des R-S (standardmäßig 'admin') |
Einträge zur Datenübertragung via SFTP:
Eintrag | Wert | Beschreibung |
---|---|---|
eoms.input.producer.sftp.host | xxx.xxx.xxx.xxx | Die IP-Adresse oder der Host-Name des Servers auf welchem das R-S arbeitet |
eoms.input.producer.sftp.port | 8080 | Ist der TCP/IP-Port unter welchem das R-S mit entfernten Applikationen kommuniziert. |
eoms.input.producer.sftp.user | admin | Ist der Nutzer-Name des System-Admininistrators des R-S (standardmäßig 'admin') |
eoms.input.producer.sftp.password | admin | Ist das Passwort des System-Admininistrators des R-S (standardmäßig 'admin') |
Start des Administrator-Client(Konsole)
generell über den Status der Datenübertragung. Des weiteren werden nach der erfolgreichen Datenübertragung über den Kommunikations-Kanal noch Variablen/Parameter übergeben, welche das docxworld-System für die Weiterverarbeitung der Daten benötigt.
Über den Daten-Kanal werden die eigentlichen Druckdaten übertragen an das docxworld-System übertragen. Als Übertragungsprotokoll für die Daten kann folgendes Protokoll verwendet werden:
- SFTP - Übertragung mittel SecureFileTransferProtocol (SSL-Verschlüsselung) an ein docxworld-System
Den Status der gesamten Verarbeitung (Kommunikation-Kanal und Daten-Kanal) gibt der Java-Client(EOMS-Input) über einen Return-Code an das aufrufende Programm zurück.
Return-Code | Bedeutung |
---|---|
0 | Die Übertragung der Daten ist vollständig und ohne Fehler abgeschlossen worden. |
1 | Bei der Kommunikation zwischen de, Java-Client(EOMS-Input) und dem docxworld-Server oder bei der Datenübertragung ist ein Fehler aufgetreten. |
Hinweis |
---|
Sind bei der Arbeit des Java-Clients(EOMS-Input) Fehler aufgetreten, so wird die genaue Fehlerursache in einer LOG-Datei protokolliert. Diese LOG-Datei finden Sie im Unterverzeichnis '/logs' im Installations-/Arbeitsverzeichnisses des Java-Clients(EOMS-Input). Der Dateiname lautet: 'eoms.input.info.log'. |
Voraussetzung für den Start des Java-Client (EOMS-Input)
- die Verfügbarkeit eines JAVA JRE ab der Version 1.6 auf dem Server wo der Java-Client ausgeführt wird
- eine installierte Version des Java-Client(EOMS-Input)
- eine korrekt definierte Konfigurationsdatei 'eoms.input.client.properties' des Java-Clients(EOMS-Input)
Start des Java-Client(EOMS-Input)
Die Kommandozeile des Java-Client(EOMS-InputDie Kommandozeile des Adminstrator-Client(Konsole) lautet wie folgt:
Codeblock |
---|
PATH_JRE\jre\bin\java -Djava.ext.dirs=lib;PATH%PATH_JREJRE%/jre/lib/ext -cp .;rseoms-input-client.jar de.profiforms.eoms.rsinput.client.admin.AdminClientStarterEOMSInputClientStarter KOMMANDOPARAMETER |
Wobei PATH_JRE der Pfad zur JAVA JRE (/bin) ist und mit KOMMANDO PARAMETER die auszuführenden Befehle des AdministratorKommandos und übergebene Variablen desJava-Client(KonsoleEOMS-Input) gemeint sind.
Info |
---|
Damit Umlaute oder Sonderzeichen bei der Eingabe über die Kommandozeile berücksichtigt werden, kann direkt hinter ..\bin\java die verwendete Codepage angegeben werden Unter dem Telnet/SSH-Client PUTTY für UNIX ist die Codepage z.B. wie folgt zu setzen: -Dsun.jnu.encoding=iso-8859-1 -Dfile.encoding=iso-8859-1 |
Kommados und Variablen des AdministratorJava-Client (KonsoleEOMS-Input)
Starten Sie den Administrator-Client(Konsole) ohne ein Kommando, so erhalten Sie eine Liste der möglichen Kommandos/Variable als Hilfe angeboten. Hier eine Auflistung der Kommandos mit Kurzbeschreibung
Kommando |
---|
Kommando-Beschreibung |
---|
- |
submit |
-createUser
<user-email/ID>
<password>
<firstname>
<lastname>
Erzeugt eines R-S Nutzer ohne Berechtigung auf Arbeitsbereiche
<user-email/ID>
Ist der Nutzername des R-S Nutzers im R-S
<password>
Ist das Passwort des R-S Nutzers
<firstname>
Ist der Vorname des R-S Nutzers
<lastname>
Ist der Familienname des R-S Nutzers
-changePassword
<user-email/ID>
<oldpassword>
<newpassword>
Ändert das Paßwort für einen bestehenden R-S Nutzer
<user-email/ID>
Ist der Nutzername des R-S Nutzers im R-S
<oldpassword>
Ist das bisherige Passwort des R-S Nutzers
<newpassword>
Ist das neue Passwort des R-S Nutzers
-resetPassword
<user-email/ID>
<newpassword>
Setzt das Passwort für einen bestehenden R-S Nutzer zurück
<user-email/ID>
Ist der Nutzername des R-S Nutzers im R-S
<newpassword>
Ist das neue Passwort des R-S Nutzers.
-createWorkspace
<name>
Erzeugt einen Arbeitsbereich mit dem angegebenen Namen im R-S
<name>
Names des Arbeitsbereiches
-assignWorkspace
<workspace-name>
<user-email/ID>
Weist einen existierenden R-S Nutzer einem Arbeitsbereich zu
<workspace-name>
Name des Arbeitsbereiches, welchem der R-S Nutzer zugeordnet werden soll
<user-email/ID>
Ist der Nutzername des R-S Nutzers im R-S
-assignWorkspaceAdmin
<workspace-name>
<user-email/ID>
Weist einen existierenden Arbeitsbereich eine R-S Nutzer mit administrativen Rechten zu
<workspace-name>
Name des Arbeitsbereiches, welchem der R-S Nutzer als Administrator zugeordnet werden soll
<user-email/ID>
Ist der Nutzername des R-S Nutzers im R-S
-unassignWorkspace
<workspace-name>
<user-email/ID>
Entfernt einen R-S Nutzer aus dem angegebenen Arbeitsbereich.
<workspace-name>
Name des Arbeitsbereiches, aus welchem der R-S Nutzer entfernt werden soll
<user-email>
Ist der Nutzername des R-S Nutzers im R-S
-renameWorkspace
<old-workspace-name>
<new-workspace-name>
<old-workspace-name>
Name des Arbeitsbereiches welcher umbenannt werden soll
<new-workspace-name>
der neue Name des Arbeitsbereiches
<destination-dir>
<bundle-id>
<destination-dir>
Verzeichnis in welches das Produktions-Paket abgelegt werden soll
<bundle-id>
ID des Produktions-Paketes im R-S
-fetchProductionBundleDW
<destination-dir>
<contract>
Führt ein Download für ein Produktions-Paket mit der angegebenen Verfahrensanummer aus dem docxworld-System in das angegebene Verzeichnis durch
<destination-dir>
Verzeichnis in welches das Produktions-Paket abgelegt werden soll
<contract>
Verfahrensnummer von docxworld
-listUsers
Zeigt alle im System vorhandene R-S Nutzer an
-listActiveUsers
Zeigt alle im System aktuell angemeldeten R-S Nutzer an
-listWorkspaces
Zeigt alle im System vorhandene Arbeitsbereiche an
-listWorkspaceUsers
<workspace-name>
Zeigt alle einem Arbeitsbereich zugeordnete R-S Nutzer an
<workspace-name>
Name des Arbeitsbereiches, für welchen die R-S Nutzer angezeigt werden soll
-scheduleGC
Startet den Reorganisations-Lauf für das Datei-Repository des R-S
-scheduleStorageInfoUpdate
Startet die Abfrage für Informationen über den Status des Datei-Repositories und gibt diese auf Konsole aus
<binary-file>
Dateiname des BinaryBundles.
<destination-dir>
<bundleid>
<destination-dir>
Verzeichnis in welches das BinaryBundle abgelegt werden soll
<bundle-id>
ID des BinaryBundles im R-S
Weist den Java-Client(EOMS-Input) an eine Übertragung von Druckdaten an das docxworld-System durchzuführen. |
Variablen werden als zweiter Stellungsparameter, jeweils getrennt durch ',' angegeben.
Variable | Variablen-Beschreibung | ||
---|---|---|---|
CUST_CUSTOMER=XXXXXXXX | Beschreibt die Ihnen zugeordnete docxworld-Kundennummer unter welcher Sie die Daten einliefern. | ||
CUST_CONTRACT=YYYYYY | Beschreibt die docxworld-Vertragsnummer für welchen Sie die Daten einliefern. | ||
CUST_REFERENCE=ZZZZZZZ |
Bezeichnet eine eineindeutige Referenz auf die eingelieferten Daten. Unter dieser Referenz können Sie Anfragen über den Status an das docxworld-System stellen. | ||
CUST_VAR[1|4]=AAAAAAA | Sind weitere vier Variablen, welche Sie in Absprache mit dem docxworld-Team als Eigenschaften für diesen Job übergeben. |
Hinweis |
---|
Verfügen Sie über keine Angaben für CUST_CUSTOMER, CUST_CONTRACT für das docxworld-System, so kontaktieren Sie bitte das docxworld-Service-Team. |
Hinweis |
---|
Die Schreibweise für Gross-/Kleinbuchstaben der Variablen ist nicht von Bedeutung. Beachten Sie weiterhin, dass Leerzeichen in Variablen-Name nicht erlaubt sind und Leerzeichen im Variablen-Inhalt mir "" umschlossen werden müssen. |