wfm.AdminGetProcessList

Dieser Job liefert zu einem Workflowmodell eine Liste aller laufenden Prozesse.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

OrganisationId

STRING

Ja

ID der Organisation.

WorkflowId

STRING

Ja

ID des Workflow-Modells.

ChunkSize

INT

Ja

Anzahl der Prozesse, die mit einer Anfrage maximal zurückgegeben werden sollen. Default: 0 gibt alle Prozesse zurück.

OrderColumn

STRING

Ja

Gibt an, nach welcher Spalte die Ergebnisliste sortiert wird. Mögliche Werte: processname und creationtime (Default). Als zweites Sortierkriterium wird immer die Prozess-ID verwendet.

Order

INT

Ja

Sortierrichtung: 1 = aufsteigend (Default), 2 = absteigend.

[LastFetchedProcessId]

STRING

Nein

Für Paging: Die letzte Prozess-ID, die in der Trefferliste zurückgegeben wurde. Im neuen Aufruf übergeben, damit die Liste erst nach dem vorigen Chunk startet. Nur bei Paging über ChunkSize notwendig.

[LastFetchedOrderValue]

STRING

Nein

Für Paging: Der letzte Wert der sortierten Spalte aus einem vorherigen Aufruf mit ChunkSize. Numerische oder Zeichenfolgenwerte möglich. Erfordert eine festgelegte LastFetchedProcessId.

[States]

INT

Nein

Status der Prozesse, die angezeigt werden sollen (Bitmask). 0 oder nicht gesetzt = alle Status. Verfügbare Werte (verodert): INIT 0x01 (1), RUNNING 0x02 (2), SUSPENDED 0x04 (4), ACTIVE 0x08 (8), TERMINATED 0x10 (16), COMPLETED 0x20 (32), SYSSUSPENDED 0x40 (64).

[Filter]

STRING

Nein

Filtertext für den Prozessnamen. Es werden nur Prozesse zurückgegeben, die diesen String an beliebiger Stelle im Namen enthalten.

2. Rückgabe

(INT): 0 = Job erfolgreich, sonst Fehlercode.

3. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

Processes

BASE64

—

Liste aller laufenden Prozesse im XML-Format.
Aufbau von Processes
<Processes>
  <Process Id="" Name="" Subject="" State="" SuspendedActivity="">
    <Creation UserId="" UserName="" Time=""/>
    <LastActivity ExecTime="" Name="" Id="" UserId="" UserName=""/>
  </Process>
</Processes>
Genauere Beschreibung der Attribute und Elemente:
Id (STRING) — ID eines Prozesses.
Name (STRING) — Name eines Prozesses.
Subject (STRING) — Betreff des Prozesses.
State (INT) — Zustand eines Prozesses: 1 = INIT, 2 = RUNNING, 4 = SUSPENDED, 8 = ACTIVE, 16 = TERMINATED, 32 = COMPLETED, 64 = SYSSUSPENDED (Prozess wurde durch Engine angehalten, z. B. aufgrund eines Fehlers im Eventskript).
SuspendedActivity (INT) — 1 = mindestens eine Aktivität des Prozesses ist angehalten, sonst 0.
Creation — Informationen zur Erzeugung des Prozesses: UserId (STRING) Benutzer-ID des Erstellers, UserName (STRING) Benutzername des Erstellers, Time (INT) Erstellungszeit.
LastActivity — Informationen zur letzten Benutzung des Prozesses: ExecTime (INT) letzte Ausführungszeit, Name (STRING) Name der zuletzt ausgeführten Aktivität, Id (STRING) ID der zuletzt ausgeführten Aktivität, UserId (STRING) ID des Ausführers, UserName (STRING) Name des Ausführers.

4. Siehe auch

wfm.AdminGetWorkflowList, wfm.GetOrganisations, wfm.AdminDeleteProcesses