Plugin-Typen - Statusverarbeitung

Page / - zuletzt bearbeitet von gru am 19.05.2020, 12:33

Statusverarbeitung

zuletzt bearbeitet von gru

am 19.05.2020, 12:33

Inhaltsverzeichnis

Schnittstelle: IPluginProcessing

Verwendungsmöglichkeiten

Methodensignaturen

Inhalt [ Verbergen ]

Schnittstelle: IPluginProcessing

Verwendungsmöglichkeiten

Methodensignaturen

Schnittstelle: IPluginProcessing

Verwendungsmöglichkeiten

Einordnung des Statusverarbeitungsplugins innerhalb der Prozesskette von Xima® Formcycle

Anbindung eigener Webservice-Schnittstellen, die übermittelte Formularwerte weiterverarbeiten sollen

Anbindung von Fremdsystemen, welche Formularwerte weiterverarbeiten sollen

Methodensignaturen

Die Plugin-Schnittstelle IPluginProcessing referenziert alle durch die Basis-Schnittstelle IFCPlugin bereitgestellten Methoden
und zusätzlich noch folgende Plugin-spezifische Methodensignaturen:

IPluginProcessingRetVal execute(IPluginProcessingParams params) throws FCPluginException

Übergabewerte:

Bei allen Parametern wird vor der Übergabe an das Plugin die Platzhalterersetzung angewendet. Dabei wird z.B. [%tf1%] innerhalb des Wertes eines Parameters durch den Inhalt des Formularfelds mit Namen tf1 eretzt. Derzeit ist es nicht einstellbar, ob die Platzhalterersetzung durchgeführt werden soll oder nicht.

Der Typ IPluginProcessingParams stellt folgende Eigenschaften bereit:

Zugriff auf den Workflow-Verarbeitungskontext (IWorkflowProcessingContext) und damit auf zentrale Objekt wie:

aktueller Vorgang

Formulardaten

Sessionparameter

Parameter aus vorgelagerten Aktionsverarbeitungen des gleichen Status

aktueller Nutzerkontext um beispielsweise Datenbankoperationen ausführen zu können

Zugriff auf das Aktionsobjekt in welcher die Verarbeitung durchgeführt wird und damit Informationen über die Einordnung der aktuellen Aktion innerhalb der Statusverarbeitung

Zugriff auf die am Statusverarbeitungs-Plugin konfigurierten Parameter

Rückgabewerte: Der Rückgabewert muss vom Typ IPluginProcessingRetVal sein. Damit ist es möglich, einfache Statuswerte (true oder false), aber auch mehrere Werte in Form von Strings oder Binärdaten einer Datei zurückzuliefern.Die nachfolgende Tabelle benennt die möglichen Rückgabe-Interfaces und deren Referenzimplementierung:

Interface	Referenzimplementierung	Beschreibung
IProcessingResultSuccess	ProcessingResultSuccess	Zurückliefern eines Status (true oder false)
IProcessingResultIntValue	ProcessingResultIntValue	Rückgabe eines Status und eines Integer-Wertes
IProcessingResultStringValue	ProcessingResultStringValue	Rückgabe eines Status und eines String-Wertes
IProcessingResultMultiValue	ProcessingResultMultiValue	Rückgabe eines Status und einer Map mit String-Werten
IProcessingResultFilePath	ProcessingResultFilePath	Rückgabe eines Status und eines Dateipfades
IProcessingResultFileData	ProcessingResultFileData	Rückgabe eines Status und den Binärdaten einer Datei

Bei fehlerhafter Abarbeitung des Plugins wird eine FCPluginException geworfen. Auf diese kann in der Statusverarbeitung von Xima® Formcycle, durch Konfiguration einer Aktion, die im Fehlerfall ausgeführt werden soll, reagiert werden.