.EWORK iLINK Interface v5.4.1

Owned by Dennis Balzuweit
März 23, 2021
2 min read

Übersicht

Der CLARC EWORK iLINK Client kann mit folgenden Startparametern aufgerufen werden:

Allgemeine Startparameter

  • Mode
  • JobId
  • TargetPath
  • JobXML
  • DocTitle

SAP spezifische Parameter

  • LogicalSAPSystem

  • ContentRepository

  • UserId

  • Language


Info

Die SAP spezifischen Parameter werden ausschließlich für die interne SAP GUI OLE Integration verwendet

Die Parameter im Detail

ParameterBeschreibung
Mode

Der Mode oder Modus bestimmt die allgemeine Verwendungsumgebung des Clients. Mögliche Werte sind:

  • SAP
  • DEFAULT
  • ADHOC

Der Modus DEFAULT erzeugt ein XML und entsprechende Dokumente - siehe JobId, TargetPath, JobXML etc.

Der Modus ADHOC öffnet einen Speichern unter Dialog.

Der Modus SAP wird für interne Zwecke in Verbindung mit den SAP-Addons benötigt.

JobId

Über die JobId wird die Benennung verschiedener Dateien geregelt. Sie dient grundsätzlich der Übergabe von Daten zwischen aufrufendem Programm und dem ILINK Client. Die JobId ist Freitext und kann beliebig lang sein. Empfohlen wird jedoch eine eindeutige Id oder GUID. Der Standardwert ist eine 32 stellige GUID.

TargetPathIm Zielverzeichnis bzw. TargetPath werden die erzeugten Dateien abgelegt.
JobXML

Im Parameter JobXML kann explizit die zu erzeugende Übergabedatei angegeben werden. Der Parameter ist jedoch optional. Im Standard wird der Wert wie folgt vorbelegt: TargetPath + JobId + .xml

DocTitle

Über den Parameter DocTitle kann ein einzelner oder eine mit Komma getrennte Liste von Titeln übergeben werden. Der Wert kann später im PDF und Übergabe-XML verwendet werden. Bei der „Mini-Verschlagwortung“ werden die Werte ebenfalls zur Auswahl angeboten.

Aufruf

cceworkilink.exe --mode=Modus --targetpath=Ziel-Pfad --jobxml=Job-XML File oder --jobid=Job-Identifier

Programmpfad ermitteln

HKLM\SOFTWARE\clarc\eWork\iLink → Path

Beispiel

cceworkilink.exe "--targetpath=c:\temp\" "--jobid=example" "--doctitle=Rechnung,Gutschrift,Angebot"

Ergebnis

Nach Beendigung des Programms wird im Ordner c:\temp\ folgendes erzeugt:

  •  <jobid>.pdf (gescannte Images)
  • example.xml (Job-Informationen)

Info

Bitte beachten Sie, dass es möglich sein kann, dass der Client-Task beendet wird und kein Job-XML-File erzeugt wird. In welchem Format der Export erfolgen soll und weitere Verarbeitungsparameter können im Client konfiguriert werden. Die Konfiguration im Client kann nur von einem User mit lokalen Admin-Berechtigungen erfolgen.

Übergabe-XML

Das Ergebnis einer Verarbeitung wird über ein entsprechendes Übergabe-XML bereitgestellt. Der Knoten Document kann n-fach vorhanden sein. Barcode, Title und Keywords sind optional. Wird im Result Node „True“ zurückgeliefert, war der Vorgang erfolgreich. Bei „False“ wird der Grund in „Message“ übergeben.

Aufbau

<?xml version="1.0" encoding="UTF-8"?>
<ccJobInfo FormatVersion="1.5" Compressed="False" Encoding="none">
  <Result>True oder False</Result>
  <Message>ggf. Langtext</Message>
  <JobId>JobId</JobId>
  <Pages>Anzahl der Seiten</Pages>
  <Document Pages="…" Barcode="…" Title="…" Keywords="…">Pfad</Document>
  <Document Pages="…" Barcode="…" Title="…" Keywords="…">Pfad</Document>
  ...
</ccJobInfo>

Beispiel

<?xml version="1.0" encoding="UTF-8"?>
<ccJobInfo FormatVersion="1.5" Compressed="False" Encoding="none">
  <Result>True</Result>
  <Message></Message>
  <JobId>example</JobId>
  <Pages>3</Pages>
  <Document Pages="1" Barcode="12345">c:\example-000001.pdf</Document>
  <Document Pages="2" Barcode="12346">c:\example-000002.pdf</Document>
</ccJobInfo>