wfm.GetEvents

Dieser Job liefert zu einer Aktivität oder zum gesamten Workflowmodell die Liste aller eingerichteten Events.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

OrganisationId

STRING

Ja

ID der Organisation

WorkflowId

STRING

Ja

ID des Workflowmodells

ActivityId

STRING

Ja

ID der Aktivität. Wird der Parameter leer gelassen, werden alle Events des Workflowmodells geliefert.

ClientTypeId

STRING

Ja

ID des verwendeten Clienttyps. Wird der Parameter leer gelassen, werden die Events aller definierten Clienttypen geliefert.

EventTypeGroups

INT

Ja

Kombinierbares Flag, gibt an welche Events angefordert werden.
1 = alle Clientevents werden zurückgeliefert
2 = das globale Clientskript wird zurückgeliefert
4 = alle Serverevents werden zurückgeliefert
8 = das globale Serverskript wird zurückgeliefert
15 = alle Events werden zurückgeliefert

Code

INT

Ja

0 = kein Skript-Code wird übertragen; 1 = Skript-Code wird übertragen

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

Events

BASE64

—

Angeforderte Eventliste im XML-Format (siehe Hinweis)

3. Rückgabe

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

4. Siehe auch

wfm.SaveEvent, wfm.DeleteEvent

5. Hinweis

Aufbau von Events
<Events>
  <Event>
    <Id></Id>
    <EventType></EventType>
    <ActivityId></ActivityId>
    <Params></Params>
    <Description></Description>
    <ClientTypeId></ClientTypeId>
    <Script Id="" Name="" Time="" Description="" ScriptLanguage="1">Skript</Script>
  </Event>
</Events>

Event — enthält weitere Elemente und die Struktur Script:

  • Id (STRING): ID des Events

  • EventType (INT): Typ des Events
    1 = BeforeForward, 2 = AfterForward, 3 = BeforeForwardTo, 4 = ButtonClick,
    5 = BeforeOpen, 6 = AfterSignature, 7 = BeforeCancel, 8 = SimulateMaskEdit,
    10000 = StartActivity, 10001 = EndActivity, 10003 = PersonalizeWorkItem,
    10004 = GetWorkItemParams, 1000000 = Globales Serverskript, 1000001 = Globales Clientskript

  • Params: für Eventtyp ButtonClick steht hier die ID des Buttons

  • Description (STRING): Derzeit nicht unterstützt — 0 übergeben.

  • ActivityId (STRING): ID der Aktivität, für die das Event erstellt wurde

  • ClientTypeId (STRING): ID des Clienttyps, für den das Event erstellt wurde

  • Script: Struktur, welche das Skript enthält:

    • Id (STRING): ID des Skripts

    • Name (STRING): Name des Skripts

    • Time (INT): Erstellungszeit des Skripts

    • Description (STRING): Derzeit nicht unterstützt — 0 übergeben.

    • ScriptLanguage (INT): Skriptsprache (1 = VB-Script, 2 = J-Script)

    • CDATA: Daten (enthält den Code des Skripts)