id

8.50 SP2

ID der Laufliste

activityId

8.50 SP2

ID der AdHoc-Container-Aktivität des Workflow-Modells

processId

8.50 SP2

ID des Workflow-Prozesses

expandable

8.50 SP2

Gibt an, ob die Laufliste erweiterbar/reduzierbar ist (true/false).

groups

8.50 SP2

Ein Array der Lauflistengruppen

adHocData

8.50 SP2

Map mit Key-Value-Paaren. Enthält Informationen zu den im Workflow-Modell konfigurierten Aktivitäten und Mahnfristen der AdHoc-Container-Aktivität.

activities

8.50 SP2

Map mit Key-Value-Paaren. Die Keys entsprechen den Namen der Aktivitäten im AdHoc-Container. Beispiel <Aktivitätsname> : <Aktivität>.

periods

8.50 SP2

Map mit Key-Value-Paaren. Die Keys entsprechen den Namen der Fristen im AdHoc-Container. Beispiel <Fristenname> : <Mahnfrist>.

defaultActivity

8.50 SP2

Standardaktivität des AdHoc-Containers

defaultPeriod

8.50 SP2

Standardmahnfrist des AdHoc-Containers

id

8.50 SP2

ID der Aktivität

deletable

8.50 SP2

Legt fest, ob die Aktivität durch den Empfänger des AdHoc-Workflows löschbar ist.

editable

8.50 SP2

Legt fest, ob die Aktivität durch den Empfänger des AdHoc-Workflows änderbar ist.

name

8.50 SP2

Name der Aktivität

participants

8.50 SP2

Array mit GUIDs der Workflowbenutzer, die diese Aktivität bearbeiten sollen.
Vgl. formHelper.getWfUser({id})

type

8.50 SP2

Typ der Aktivität. Mögliche Werte sind:

• WORKITEM

• ROUTE

• MULTIINSTANCE

id

8.50 SP2

ID der Mahnfrist

name

8.50 SP2

Name der Mahnfrist

duration

8.50 SP2

Relative Länge der Mahnfrist ab der letzten Weiterleitung

setExpandable({expandable})

8.50 SP2

Setzt für die Laufliste die Eigenschaft, ob die Laufliste im Client erweiterbar sein soll.

Parameter:

• expandable – true oder false, je nachdem ob die Laufliste erweiterbar sein soll oder nicht

isValid()

8.50 SP2

Gibt zurück, ob die Laufliste valide ist. Eine Laufliste ist valide, wenn all ihre enthaltenen Gruppen valide sind (siehe Lauflistengruppe API - Is valid). Fehler werden ggf. in der Browserconsole ausgegeben.

getGroupById({id})

8.50 SP2

Liefert gegebenenfalls die Gruppe mit der übergebenen ID zurück.

Parameter:

• id – ID der Gruppe

createGroup({expandable})

8.50 SP2

Erstellt eine neue Gruppe und fügt diese am Ende der Laufliste hinzu. Ggf. werden die Properties der Gruppe mit den Informationen aus den Parametern gefüllt. Die erstellte Gruppe wird zurückgeliefert.

Optionale Parameter:

• expandable – ist die Gruppe erweiterbar

createGroupAt({index}, {expandable})

8.50 SP2

Erstellt eine neue Gruppe und fügt diese der Laufliste an der angegebenen Position hinzu. Ggf. werden die Properties der Gruppe mit den Informationen aus den Parametern gefüllt. Die erstellte Gruppe wird zurückgeliefert.

Parameter:

• index (integer) – Position in der Laufliste; die Position ist 0-basiert

Optionale Parameter:

• expandable – ist die Gruppe erweiterbar

addGroup({group}, {fromTemplate})

8.50 SP2

Fügt eine Gruppe am Ende der Laufliste hinzu. Sollten Sie über diese Methode einzelne Gruppen einer Lauflistenvorlage manuell einfügen wollen, so kopieren Sie die Laufliste der Vorlage bitte zuvor über 'routingList.api.copy()'.

Parameter:

• group – die Gruppe

• fromTemplate (boolean) – entstammt die Laufliste einer Lauflistenvorlage

addGroupAt({group}, {index}, {fromTemplate})

8.50 SP2

Fügt eine Gruppe der Laufliste an der angegebenen Position hinzu. Sollten Sie über diese Methode einzelne Gruppen einer Lauflistenvorlage manuell einfügen wollen, so kopieren Sie die Laufliste der Vorlage bitte zuvor über 'routingList.api.copy()'.

Parameter:

• group – die Gruppe

• index – Position in der Laufliste

• fromTemplate – entstammt die Laufliste einer Lauflistenvorlage

removeGroup({group})

8.50 SP2

Entfernt die Gruppe aus der Laufliste.

Parameter:

• group – die Gruppe

removeGroupById({id})

8.50 SP2

Entfernt die Gruppe mit der übergebenen ID aus der Laufliste.

Parameter:

• id – ID des Lauflisteneintrags

addList({list}, {fromTemplate})

8.50 SP2

Kopiert die Gruppen einer Laufliste in diese Laufliste.

Parameter:

• list – die Laufliste, deren Gruppen hinzugefügt werden sollen

• fromTemplate – entstammt die Laufliste einer Lauflistenvorlage

addListAt({list}, {index}, {fromTemplate})

8.50 SP2

Kopiert die Gruppen einer Laufliste und fügt die kopierten Gruppen an einer bestimmten Position in dieser Laufliste ein.

Parameter:

• list – die Laufliste, deren Gruppen hinzugefügt werden sollen

• index – Position in der Laufliste

• fromTemplate – entstammt die Laufliste einer Lauflistenvorlage

saveAsTemplate(name, isPublic, templateToOverwrite)

8.50 SP2

Speichert die Laufliste als Vorlage unter dem angegebenen Namen. Es kann eine Lauflistenvorlage übergeben werden, welche überschrieben werden soll.

Parameter:

• name – Name der neuen Lauflistenvorlage

• isPublic – soll die neue Lauflistenvorlage öffentlich sein

• templateToOverwrite – (optional) ein Template, welches mit der zu speichernden Routingliste überschrieben werden soll

id

8.50 SP2

ID der Lauflistengruppe

expandable

8.50 SP2

Legt fest, ob die Lauflistengruppe erweiterbar/reduzierbar ist (true/false).

isNew

8.50 SP2

Legt fest, ob die Gruppe der Laufliste neu hinzugefügt wurde, aber noch nicht gespeichert ist (true/false).

items

8.50 SP2

Map mit Key-Value-Paaren. Die Keys entsprechen den IDs der jeweiligen LauflistenItems. Beispiel: <ID> : <LauflistenItem>.

setExpandable({expandable})

8.50 SP2

Setzt für die Gruppe die Eigenschaft, ob die Gruppe im Client erweiterbar sein soll.

Parameter:

• expandable – true oder false, je nachdem ob die Gruppe erweiterbar sein soll

isValid()

8.50 SP2

Gibt zurück, ob die Gruppe valide ist. Eine Gruppe ist valide, wenn sie mindestens ein Item enthält und alle in ihr enthaltenen Items valide sind (siehe Lauflistenitem API - Is valid). Fehler werden ggf. in der Browserconsole ausgegeben.

containsItemById({id})

8.50 SP2

Liefert einen boolschen Wert zurück, der angibt, ob die Gruppe ein Lauflisten-Item mit der übergebenen ID enthält.

Parameter:

• id – ID des Items

getItemById({id})

8.50 SP2

Liefert gegebenenfalls das Lauflisten-Item mit der übergebenen ID zurück.

Parameter:

• id – ID des Items

createItem({activity}, {period})

8.50 SP2

Erstellt ein neues Lauflisten-Item und fügt dieses der Gruppe hinzu. Ggf. werden die Properties des Items mit den Informationen aus den Parametern gefüllt. Das erstellte Lauflistenitem wird zurückgeliefert.

Optionale Parameter:

• activity – ein Aktivitätsobjekt (siehe adHocData)

• period – ein Fristenobjekt (siehe adHocData)

addItem({item})

8.50 SP2

Fügt ein Lauflisten-Item der Gruppe hinzu.

Parameter:

• item – das Lauflisten-Item

removeItem({item})

8.50 SP2

Entfernt das Lauflisten-Item aus der Gruppe.

Parameter:

• item – das Lauflisten-Item

removeItemById({id})

8.50 SP2

Entfernt das Lauflisten-Item mit der übergebenen ID aus der Gruppe.

Parameter:

• id – ID des Lauflisten-Items

moveTo({list}, {index})

8.50 SP2

Entfernt die Gruppe aus seiner momentanen Laufliste und fügt sie in die übergebene Laufliste ein.

Parameter:

• list – Laufliste, der die Gruppe zugeordnet werden soll

Optionale Parameter:

• index - Position an der die Gruppe eingefügt werden soll

copy()

8.50 SP2

Erstellt mit den Einstellungen der Gruppe eine neue Gruppe und gibt diese zurück.

id

8.50 SP2

ID des Lauflisten-Items

deletable

8.50 SP2

Legt fest, ob das Lauflisten-Item von einem nicht prozessverantwortlichen Benutzer löschbar ist.

editable

8.50 SP2

Legt fest, ob das Lauflisten-Item von einem nicht prozessverantwortlichen Benutzer bearbeitbar ist.

participants

8.50 SP2

Ein Array mit den Namen der Bearbeiter, die der Aktivität des Lauflisten-Items zugewiesen werden.

remark

8.50 SP2

Freitext für Bearbeitungshinweise

taskName

8.50 SP2

Freitext für eine Aktivitätsbezeichnung

activityName

8.50 SP2

Name der Aktivität im Workflow-Modell

periodName

8.50 SP2

Name der Mahnfrist im Workflow-Modell

dueOn

8.50 SP2

Datum, an dem die Mahnfrist gefeuert werden soll.

timerType

8.50 SP2

Gibt an, wie die Eskalationszeit der ggf. ausgewählten Mahnfrist zu werten ist. Folgende Werte sind zulässig:

• 0 – keine Frist

• 1 – relativ zum Start der Aktivität

• 2 – (absolut) zum ausgewählten Datum

setActivityData({activity})

8.50 SP2

Setzt die Eigenschaften des Lauflisten-Items mit den Daten der übergebenen Aktivität.

Parameter:

• activity – ein Aktivitätsobjekt (siehe adHocData)

setPeriodData({period})

8.50 SP2

Setzt die Eigenschaften des Lauflisten-Items mit den Daten der übergebenen Mahnfrist.

Parameter:

• period – ein Mahnfristobjekt (siehe adHocData)

isValid()

8.50 SP2

Gibt zurück, ob die Eigenschaften des Lauflisten-Items valide sind. Fehler werden ggf. in der Browserconsole ausgegeben. Ein Item ist valide, wenn:

• eine Aktivität gesetzt ist, die im AdHoc Container zur Verfügung steht.

• für alle Aktivitäten, die nicht vom Aktivitätstyp "Route" sind, Teilnehmer gesetzt sind.

• wenn eine Mahnfrist gesetzt ist, diese im AdHoc-Container zur Verfügung steht und ein Eskalationsdatum gesetzt wurde.

remove()

8.50 SP2

Entfernt das Lauflisten-Item aus seinem Lauflisteneintrag.

moveTo({group})

8.50 SP2

Entfernt das Lauflisten-Item aus seiner aktuellen Gruppe und fügt diese in die übergebenen Gruppe ein.

Parameter:

• group – Gruppe, der das Lauflisten-Item zugeordnet werden soll

copy()

8.50 SP2

Erstellt mit den Einstellungen des Lauflisten-Items ein neues Lauflisten-Item und gibt dieses zurück.