4.1 Methoden
- Team Dodo
- Technische Redaktion
Das 'formHelper'-Objekt hat Funktionen, die sich ausschließlich auf den aktuell geöffneten Workflow beziehen. Auf diese Weise können die Workflow-Akteninhalte manipuliert oder der Workflow direkt weitergeleitet werden.
- 1 formHelper.forwardWorkflow()
- 2 formHelper.saveWorkflow()
- 3 formHelper.cancelWorkflow()
- 4 formHelper.forward()
- 5 formHelper.getFiles()
- 6 formHelper.getFile({osid})
- 7 formHelper.addFile({osid}, {objectTypeId}, {fileArea}, {trayLocation})
- 8 formHelper.removeFile({osid})
- 9 formHelper.getWfFiles()
- 10 formHelper.getWfFile({osid})
- 11 formHelper.setActiveWorkflowTab()
- 12 formHelper.hideWorkflowTabs({tabs})
- 13 formHelper.getProtocol()
- 14 formHelper.addProtocolEntry({msg})
- 15 formHelper.addProtocolEntry({data})
- 16 formHelper.getRoutingList()
- 17 formHelper.isUserProcessResponsible()
API-Methode | Verfügbar ab | Offline | Beschreibung |
|---|---|---|---|
formHelper.forwardWorkflow() | 8.50 Final Deprecated | NEIN | Achtung: Diese Funktion wird ab der Version 9.0 nicht mehr unterstützt. Alternativ muss die Funktion "formHelper.forward()" verwendet werden Leitet den aktuellen Vorgangsschritt weiter. Der Anwender wird zur vorigen Seite im WebClient zurückgeleitet oder, wenn keine derartige existiert, zum Workfloweingang. |
formHelper.saveWorkflow() | 8.50 Final Deprecated | NEIN | Achtung: Diese Funktion wird ab der Version 9.0 nicht mehr unterstützt. Alternativ muss die Funktion "formHelper.save()" verwendet werden Speichert den aktuellen Vorgangsschritt. |
formHelper.cancelWorkflow() | 8.50 Final Deprecated | NEIN | Achtung: Diese Funktion wird ab der Version 9.0 nicht mehr unterstützt. Alternativ muss die Funktion "formHelper.cancel()" verwendet werden Bricht die Bearbeitung des Workflowformulars ab. Der Anwender wird zur vorigen Seite im WebClient zurückgeleitet oder, wenn keine derartige existiert, zum Workfloweingang. |
formHelper.forward() | 8.50 SP 5 | NEIN | Leitet den Workflow weiter. Diese Funktion existiert nur auf Workflowmasken. |
formHelper.getFiles() | 8.50 Final | NEIN | Liefert ein Objekt mit allen Files als Key-Value-Paare. Der Key entspricht der OSID des ECM-Objektes. Die Value ist ein Aktenobjekt. |
formHelper.getFile({osid}) | 8.50 Final | NEIN | Liefert ein Aktenobjekt zu einer OSID oder NULL, wenn kein Aktendokument mit dieser OSID existiert. Parameter:
|
formHelper.addFile({osid}, {objectTypeId}, {fileArea}, {trayLocation}) | 8.50 Final | NEIN | Fügt ein DMS-Dokument in die Akte ein. Es können nur Dokumente eingefügt werden, die auch einen Standort im System haben. Parameter:
Optionale Parameter
Rückgabe: 'addFile' wird asynchron ausgeführt und kann mit einem Error- und Success callback versehen werden. Als Response im Success callback erhält man ein File-Objekt, bestehend aus dem wfFile, dem dmsDocument und der Originalantwort von enaio appconnector. Beispiel: formHelper.addFile(10338, 28664, "info", 1).then(function(file){
console.log(file)
},
function(error){
console.log(error)
}); |
formHelper.removeFile({osid}) | 8.50 Final | NEIN | Entfernt das Aktendokument mit der gegebenen OSID aus der Workflowakte. Parameter:
Das Dokument wird erst beim Speichern oder Weiterleiten endgültig aus der Akte entfernt. |
formHelper.getWfFiles() | 8.50 Final | NEIN | Liefert ein Objekt mit allen Aktendokumenten zurück. Innerhalb des Objektes ist die OSID jedes Aktendokumentes der Schlüssel. Über diesen kann einfach auf ein Aktendokument zugegriffen werden. |
formHelper.getWfFile({osid}) | 8.50 Final | NEIN | Liefert das gewünschte Aktendokument zu einem OSID zurück oder NULL, wenn kein Aktendokument zu der angegebenen OSID exisitert. Parameter:
|
formHelper.setActiveWorkflowTab() | 8.50 Final | NEIN | Wechselt zum gewünschten Tab im Workflow. Parameter:
|
formHelper.hideWorkflowTabs({tabs}) | 8.50 SP2 | NEIN | Blendet die gewünschten Tabs in der Tabauswahl aus. Parameter:
|
formHelper.getProtocol() | 8.50 SP2 | NEIN | Liefert das Workflow Protokollobjekt zurück oder NULL, wenn der Workflow über kein Protokoll verfügt. |
formHelper.addProtocolEntry({msg}) | 8.50 SP2 | NEIN | Fügt dem Workflow-Protokoll einen Eintrag vom angemeldeten Nutzer hinzu. Voraussetzung ist das Attribut Protokoll in der Protokollvariable. Parameter:
Zur Version 11.10 werden Standard-Spaltenbezeichner in der Protokolltabelle in der jeweiligen Benutzersprache übersetzt angezeigt. Dafür wird das Attribut Protokoll in der Protokollvariable auf osAction geändert. |
formHelper.addProtocolEntry({data}) | 8.50 SP4 | NEIN | Fügt dem Workflow-Protokoll einen Eintrag vom angemeldeten Nutzer hinzu. Die Spalten "Datum", "Zeit" (vormals "Uhrzeit"), "Benutzer", "Aktivität" werden automatisch gefüllt. Die Werte für weitere Spalten wie "Aktion" (vormals "Protokoll") und benutzerdefinierte Spalten können als Parameter übergeben werden. Parameter:
Für jedes Key-Value-Paar muss es ein passendes Attribut in der Protokollvariable geben. Zur Version 11.10 werden Standard-Spaltenbezeichner in der Protokolltabelle in der jeweiligen Benutzersprache übersetzt angezeigt. Dafür wird das Attribut Protokoll in der Protokollvariable auf osAction geändert. Benutzerdefinierte Spalten werden nicht übersetzt. |
formHelper.getRoutingList() | 8.50 SP2 | NEIN | Liefert gegebenenfalls die Laufliste eines Workflows zurück, insofern dieser eine besitzt, ansonsten NULL. |
formHelper.isUserProcessResponsible() | 8.50 SP2 | NEIN | Gibt an, ob der angemeldete Nutzer Prozessverantwortlicher des Prozesses ist. |