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:

• osid (integer) – OSID des Aktendokuments

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:

• osid (integer) – OSID des einzufügenden DMS-Dokuments

Optionale Parameter

• objectTypeId (int) - Objekttyp ID

• fileArea (string) – legt fest, in welchen Aktenbereich das Dokument eingefügt wird. Akzeptiert wird 'info' oder 'work'.

• trayLocation (int) – Besitzt ein Dokument bereits einen Standort im DMS, übergeben Sie hier den Wert 1 (oder lassen den Parameter weg). Befindet sich das Dokument hingegen in der Workflow-Ablage (workflow tray) und hat damit noch keinen Standort im DMS, so muss hier der Wert 2 übergeben werden (besonders wichtig bei typenlosen Dokumenten).

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.
Vgl. Workflow Aktendokument.

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:

• osid (integer) – OSID des zu entfernenden Aktendokuments

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:

• osid (integer) – OSID des Aktendokuments

formHelper.setActiveWorkflowTab()

8.50 Final

NEIN

Wechselt zum gewünschten Tab im Workflow.

Parameter:

• tab (string) – der Name des Tabs, zu dem gewechselt werden soll. Mögliche Werte sind:

  • mask – Workflowmaske

  • files – Workflowakte

  • protocol – Workflowprotokoll (nicht immer verfügbar)

  • routingList – Workflowroutinglist (nicht immer verfügbar)

formHelper.hideWorkflowTabs({tabs})

8.50 SP2

NEIN

Blendet die gewünschten Tabs in der Tabauswahl aus.

Parameter:

• tabs – ein Array der Namen der Tabs oder ein Tabname als String, die ausgeblendet werden sollen. Mögliche Arraywerte sind:

  • mask – Workflowmask

  • files – Workflowakte

  • protocol – Workflowprotokoll (nicht immer verfügbar)

  • routingList – Workflowroutinglist (nicht immer verfügbar)

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:

• msg(string) – die Protokollnachricht, die im Protokolleintrag erscheinen soll.

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:

• data(object) – Map mit Key-Value-Paaren: Spaltenname - Wert.

Für jedes Key-Value-Paar muss es ein passendes Attribut in der Protokollvariable geben.

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.