OneOffixx Connect kann sowohl von der Client-Applikation als auch auf dem Server verarbeitet werden. Das Format ist dabei identisch, wobei einige Operationen nur auf dem Client selbst ausführbar sind, z. B. das Starten von Microsoft Word nach Erstellung eines Dokuments.

Connect Verarbeitung auf dem Client

Die Fachapplikation ruft OneOffixx über eine der folgenden Methoden auf:

  • Via Prozess: “c:\program…\OneOffixx.exe /connector “XYZDatei.xml”
  • Via Protokollhandler: oneoffixx:connector=”XYZDatei.xml” oder oneoffixx:new=guid
  • Via Shell: File Association *.ooconnect, *oocx, *oock

ACHTUNG: OneOffixx löscht nach der Verarbeitung automatisch das Connect File. Wird das zusätzliche Argument /keepConnector übergeben, kann dieses Verhalten unterdrückt werden. Wird via Shell aufgerufen, dann muss die Dateiendung “.oock” verwendet werden.

TemplatePicker:

NEU ab 3.3.1

Wenn keine TemplateId, kein Template-Filter oder kein Speicherort von einem bestehenden Dokument angegeben sind, wird der TemplatePicker mit allen verfügbaren Vorlagen angezeigt. Dabei sind die Vorlagen nach Kategorien gruppiert.

Connect Verarbeitung auf dem Server

Im Falle der serverseitigen Verarbeitung wird ein extra API Benutzer benötigt, der in der Serverkonfiguration hinterlegt werden muss. Zur Kommunikation zwischen Aufrufer und der serverseitigen REST-Schnittstelle wird das HTTP Protokoll verwendet. Die Authentifizierung des Clients erfolgt durch HTTP Basic Authentifizierung, daher wird empfohlen, die Kommunikation zwischen Client und Server durch SSL abzusichern. Um OneOffixx Connect auf dem Server zu verarbeiten, muss vorher ein „Client” auf der serverseitig konfiguriert werden. Über diese „Client”-Konfiguration wird auch der Name und das Passwort für die Authentifizierung festgelegt. Das Connect-XML muss als HTTP POST samt dem „Authorization”-Header gesendet werden. Bei einer erfolgreichen Verarbeitung wird das erzeugte Dokument zurück gegeben. Beispiel:

HTTP POST "https://{server}/api/V1/connect"

Headers: 
Authorization Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Im Body das OneOffixxConnect XML hinterlegen:

  • Der Basic Authentication-Header ist im Beispiel “username:password” als Base64 encodiert.

Optionale Parameter:

TenantId & DatasourceId - siehe OneOffixx.config

HTTP POST "https://{server}/api/V1/connect?tenantId=&datasourceId="

Beispiel:

HTTP POST "https://{server}/api/V1/connect?tenantId=f4edff9a-18ab-4a24-9532-8497113e094c&datasourceId=331ece2a-cfba-47f6-8434-8c2d13c50678

Ergebnis

Das Ergebnis eines Connect-Aufrufs wird auch als XML-Datei an der gleichen Stelle wie das Input-XML abgelegt. Der Dateiname hat die folgende Form:

result_NameInputfile_Zeitstempel.xml

Standardmässig wird die Datei nur bei einem Fehler erstellt. Mit dem Argument /CreateConnectorResult, wird die Datei immer erzeugt, mit dem Argument /CreateConnectorResultOnError → “false” wird die Funktionalität ganz deaktiviert. Alternativ können die Parameter im Dokument geändert werden.

Die Fehlerdatei hat das folgende Format:

<?xml version="1.0" encoding="utf-16"?>
<OneOffixxConnectResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result><!-- Success oder Error oder Unknown --></Result>
  <Message><!-- Exception bei einem Fehler --></Message>
  <Details>
    <InputFile><!-- Pfad zum Input-File --></InputFile>
    <Input><!-- Input-File --></Input>
    <Connect><!-- Connect-File --></Connect>
    <InterfaceType><!-- Interface-Typ für Tranformation (z. Bsp. Klib) --></InterfaceType>
    <InterfaceVersion><!-- Interface-Version --></InterfaceVersion>
    <InterfaceConfiguration><!-- Interface-Konfiguration (Transformation) --></InterfaceConfiguration>
  </Details>
</OneOffixxConnectResult>