wfm.GetWorkItem

Dieser Job startet einen Arbeitsschritt. Der Arbeitsschritt wird für den angegebenen Benutzer personalisiert. Es werden zusätzlich alle benötigten Daten (Maske, Akte und Workflowvariablen) für den Client zurückgeliefert.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

UserId

STRING

Ja

ID des Benutzers

WorkItemId

STRING

Ja

Instanz-ID der Aktivität

ClientTypeId

STRING

Ja

ID des verwendeten Clienttyps

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

ExtendedAttributes

BASE64

—

Liste mit Daten zu den Parametern (Attribute) im XML-Format (siehe Hinweis)

File

BASE64

—

Liste mit Dokumenten des Info-/Arbeitsbereiches der WF-Akte im XML-Format (siehe Hinweis)

Masks

BASE64

—

Maskendaten im XML-Format (siehe Hinweis)

Parameters

BASE64

—

Liste mit Parametern zur Datenmaske im XML-Format (siehe Hinweis)

[RoutingList]

BASE64

Optional

Laufliste (optional, siehe Hinweis)

3. Rückgabe

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

4. Siehe auch

wfm.GetWorkItemList, wfm.CancelWorkItem, wfm.CompleteWorkItem

5. Hinweis

Aufbau von ExtendedAttributes
<ExtendedAttributes>
  <ExtendedAttribute Name="MASKID" Value=""/>
  <ExtendedAttribute Name="SEND_BUTTON" Value="0"/>
  <ExtendedAttribute Name="SENDTO_BUTTON" Value="0"/>
  <ExtendedAttribute Name="END_BUTTON" Value="0"/>
  <ExtendedAttribute Name="SIGN_ACTIVITY" Value=""/>
  <ExtendedAttribute Name="CHECK_PASSWORD" Value=""/>
</ExtendedAttributes>

ExtendedAttributes — Liste von Parametern (Attribute) mit folgender Struktur:

  • Name (STRING): Name des Attributes

    • MASKID: GUID der Workflowmaske

    • SEND_BUTTON: Anzeige des Weiterleiten-Buttons

    • END_BUTTON: Anzeige des Beenden-Buttons

    • SIGN_ACTIVITY: 1 = Digitale Signatur erforderlich, ansonsten 0

    • CHECK_PASSWORD: 1 = zum Weiterleiten muss Passwort eingegeben werden, ansonsten 0

  • Value: Wert des Attributes

Aufbau von File
<File>
  <Docs>
    <Doc Id="" Type="" Rights="" Location="" Workspace="" Deleteable="0" Moveable="1"
      UseActiveVariant="" OriginalId="" Display=""/>
  </Docs>
</File>

File kapselt die Parameter Workspace und Infospace. Docs ist eine Liste von Dokument-Parametern (Doc):

  • Id (INT): ID des Dokuments aus dem DMS

  • Type (INT): Typ des Dokuments

  • Rights (INT): Zugriffsrechte
    0 = accessDenied, 1 = accessView, 2 = accessEdit, 4 = accessDelete, 8 = accessEditDataSheet, 15 = accessAll

  • Location (INT): Standort des Dokuments (1 = SDREL, 2 = WF-Ablage)

  • Workspace (INT): gibt an, ob sich das Objekt im Infobereich (0) oder im Arbeitsbereich (1) befindet

  • Deleteable (INT): gibt an, ob das Dokument aus der Akte gelöscht werden darf (0 = nein, 1 = ja)

  • Moveable (INT): gibt an, ob das Dokument in der Akte verschoben werden darf (0 = nein, 1 = ja)

  • UseActiveVariant (INT): gibt an, ob für das Objekt die aktive Variante verwendet werden soll (0 = nein, 1 = ja)

  • OriginalId (INT): gibt an, welches Dokument ursprünglich in die Akte gezogen wurde

  • Display (INT): gibt an, ob dieses Dokument in der Vorschau angezeigt werden soll (0 = nein, 1 = ja)

Aufbau von Masks
<Masks>
  <Mask Id="" Name="" Flags="" FrameWidth="" FrameHeight="">
    <MaskField Id="" Name="" InternalName="" TabOrder="" DataType="" InpLen="" Init=""
      Flags="" Flags1="" Flags2="" InpLeft="" InpTop="" InpRight="" InpBottom=""
      FieldLeft="" FieldTop="" FieldRight="" FieldBottom="" ToolTip="" ValuesId="">
      <MaskFieldVal><![CDATA[ ]]></MaskFieldVal>
    </MaskField>
  </Mask>
</Masks>

Masks — Liste der Masken (Mask):

  • Id (STRING): ID der Maske

  • Name (STRING): Name der Maske

  • Flags (INT): Flags

  • FrameWidth (INT): Breite der Maske

  • FrameHeight (INT): Höhe der Maske

  • MaskField: Struktur, die Informationen zu einem Maskenfeld beinhaltet; enthält entweder den Wert des Maskenfeldes (MaskFieldVal) oder eine Liste von Maskenfeld-Controls (MaskListCtrls)

    • Id (STRING): ID des Maskenfeldes

    • Name (STRING): Name

    • InternalName (STRING): interner Name

    • TabOrder (INT): Tabulatorreihenfolge

    • DataType (INT): Datentyp

    • InpLen (INT): Länge der Eingabe

    • Init (STRING): Initialisierungswert

    • Flags (INT): Flags

    • Flags1 (INT): weitere Flags

    • Flags2 (INT): weitere Flags

    • InpLeft (INT): X-Position des Eingabefeldes

    • InpTop (INT): Y-Position des Eingabefeldes

    • InpRight (INT): Breite des Eingabefeldes

    • InpBottom (INT): Höhe des Eingabefeldes

    • FieldLeft (INT): X-Position der Feldbezeichnung

    • FieldTop (INT): Y-Position der Feldbezeichnung

    • FieldRight (INT): Breite der Feldbezeichnung in Pixel

    • FieldBottom (INT): Höhe der Feldbezeichnung in Pixel

    • ToolTip (INT): Tooltip

    • ValuesId (INT): Verweis auf Listenfelder

    • MaskFieldVal: Wert des Maskenfeldes als CDATA

    • MaskListCtrl: Struktur mit Informationen zu einem Maskenfeld-Control

      • ColPos (INT): Position der Spalte

      • Name (STRING): Name

      • Type (STRING): Typ

      • Length (INT): Länge

      • ColWidth (INT): Spaltenbreite

      • Color (INT): Farbe

      • TextAlign (INT): Bündigkeit des Textes

      • ValuesId (STRING): Verweis auf Listenfelder

      • MaskListCtrlVal: Wert des Maskenfeld-Controls als CDATA

    • Page: Struktur mit Informationen zu einem Page-Control (enthält weitere MaskFields)

      • Id (STRING): ID des Pagecontrols

      • Name (STRING): Name des Pagecontrols

      • Number (INT): gibt die Position ("Seitenzahl") einer Page an

      • IconId (INT): ID des Icons (aus DB-Tab. Osicons), welches auf dem Pagecontrol angezeigt werden soll

Aufbau von Parameters
<Parameters>
  <Parameter FormField="" DataField="" Name="" Mode="" Selection=""
    InfoText="" ListType=""><![CDATA[ ]]></Parameter>
</Parameters>

Parameters — Liste der formalen Parameter:

  • FormField (STRING): ID des Feldes auf einem Formularblatt, dem die Workflowvariable zugeordnet ist; wenn keine Zuordnung besteht: Name der Workflowvariable

  • DataField (STRING): ID der Workflowvariable

  • Name (STRING): Name der Workflowvariable

  • Mode (INT): Modus der Workflowvariable
    1 = EingabeParameter, 2 = AusgabeParameter, 3 = Ein/Ausgabeparameter

  • Selection (STRING): Auswahltyp bei Workflowvariablen in Listenform (single oder multi:x)

  • InfoText (STRING): Informationstext bei Workflowvariablen in Listenform

  • ListType (STRING): Typ der Liste (ProcessList, UserList, UserDefList)

  • CDATA: Aufbau und Daten der Workflowvariable

Aufbau von RoutingList
<RoutingList Id="3294B433BFF6454D9C861B86B5A8AD5D"
  ProcessId="BA16C21BB96D46D099E72070BCB644CC"
  ActivityId="3294B433BFF6454D9C861B86B5A8AD5D" Expandable="1">
  <Entries>
    <Entry Nr="203" Expandable="1">
      <Item Id="99825B18A8334987935684FDA3D6A40D"
        ActivityId="6EE4490A48164A0FA6DC34A80099AF66" ActivityName="Rechnung erstellen"
        ModelActivityName="Rechnung erstellen" Remark="" TimerId="" TimerDuration=""
        TimerDurationType="" Changeable="1" Deleteable="0">
        <ObjectIds></ObjectIds>
      </Item>
    </Entry>
  </Entries>
</RoutingList>

RoutingList — Laufliste (Struktur identisch mit wfm.CompleteWorkItem).