workflow_list_by_family()

Liefert alle Workflowmodelle einer Workflowfamilie über wfm.GetWorkflowListByFamily.

Eine Familie bündelt die Versionen eines Workflowmodells. Genau ein Modell je Familie ist in Benutzung (ECMWorkflowFamilyModelState.IN_USE); neue Prozesse starten aus diesem. Die Familien selbst liefert projects() als Einträge vom Typ FAMILY.

1. Signatur

  • Sync

  • Async

ecm.workflow.workflow_list_by_family(
    family: str | ECMWorkflowProject,
    organisation: str | ECMOrganisation | None = None,
) -> list[ECMWorkflowFamilyModel]
await ecm.workflow.workflow_list_by_family(
    family: str | ECMWorkflowProject,
    organisation: str | ECMOrganisation | None = None,
) -> list[ECMWorkflowFamilyModel]

2. Parameter

Parameter Typ Beschreibung

family

str | ECMWorkflowProject

Die Familie als GUID oder als ECMWorkflowProject vom Typ FAMILY aus projects().

organisation

str | ECMOrganisation | None

Die Organisation als GUID oder als ECMOrganisation. Ohne Angabe wird die aktive Organisation verwendet.

3. Rückgabewert

Eine Liste von ECMWorkflowFamilyModel in Serverreihenfolge. Leere Liste, wenn die Familie keine Modelle enthält.

Gemessen auf enaio 12.0: Eine unbekannte GUID oder die GUID eines Nicht-Familien-Projekts ist kein Fehler. Der Server antwortet mit <Workflows><Resources/></Workflows>, also einer leeren Liste.

3.1. Felder von ECMWorkflowFamilyModel

Feld Typ Beschreibung

id

str

GUID des Workflowmodells (Id); der Wert, den wfm.GetWorkflow erwartet.

name

str

Technischer Modellname (Name), z. B. Ad-hoc Version 3.0.5.

state

ECMWorkflowFamilyModelState

Modellstatus (State), siehe unten.

creator_id

str

GUID des Erstellers (Creator).

created_at

datetime | None

Erstellzeit als UTC-datetime (CreationTime). None, wo der Server 0 meldet.

version

int

Versionsnummer des Modells innerhalb der Familie (Version).

lock_user_id

str

GUID des Benutzers, der die Bearbeitungssperre hält (LockId), leer ohne Sperre.

lock_user_name

str

Name des Benutzers, der die Bearbeitungssperre hält (LockName), leer ohne Sperre.

locked_at

datetime | None

Zeitpunkt der Sperre als UTC-datetime (LockTime). None ohne Sperre.

description

str

Beschreibung des Modells (Description), leer wenn nicht gesetzt.

icon_id

int

Icon-ID des Modells (IconId), 0 ohne Icon.

localised_names

Mapping[str, str]

Anzeigename je Locale, z. B. {"de_DE": "Ad-hoc Workflow 3.0.5"}. Aufgelöst aus dem <Resources>-Block der Antwort über ModelNameResId. Leer, wenn der Server keine Ressource liefert.

localised_descriptions

Mapping[str, str]

Beschreibung je Locale, aufgelöst über DescriptionResId. Leer, wenn der Server keine Ressource liefert.

3.2. Werte von ECMWorkflowFamilyModelState

Member Wert Bedeutung

IN_USE

1

Das Modell ist in Benutzung: Neue Prozesse können daraus gestartet werden. Genau eines je Familie.

LOCKED

2

Das Modell ist für die Bearbeitung gesperrt.

IN_PROCESSING

3

Das Modell wird bearbeitet, ist aber nicht gesperrt.

TEST_RELEASED

4

Das Modell ist zum Test freigegeben.

DELETED

5

Das Modell ist gelöscht, aber noch in der Datenbank enthalten.

RELEASED

6

Das Modell ist freigegeben, aber nicht in Benutzung: keine neuen Prozesse, laufende werden noch beendet.

Das Serverhandbuch dokumentiert nur die Attribute von <Workflow>. Gemessen auf enaio 12.0 trägt die Antwort zusätzlich ModelNameResId und DescriptionResId sowie einen abschliessenden <Resources>-Block mit den lokalisierten Texten je Locale. Der Client führt beides zusammen; die Ressourcen-IDs werden nicht nach aussen gegeben.

4. Beispiele

4.1. Modelle aller Familien auflisten

  • Sync

  • Async

from ecmind_blue_client.ecm import ECMWorkflowProjectType

families = [p for p in ecm.workflow.projects() if p.type is ECMWorkflowProjectType.FAMILY]
for family in families:
    for model in ecm.workflow.workflow_list_by_family(family):
        print(f"{family.name}: {model.name} v{model.version} {model.state.name}")
from ecmind_blue_client.ecm import ECMWorkflowProjectType

projects = await ecm.workflow.projects()
for family in (p for p in projects if p.type is ECMWorkflowProjectType.FAMILY):
    for model in await ecm.workflow.workflow_list_by_family(family):
        print(f"{family.name}: {model.name} v{model.version} {model.state.name}")

4.2. Das Modell in Benutzung finden

  • Sync

  • Async

from ecmind_blue_client.ecm import ECMWorkflowFamilyModelState

models = ecm.workflow.workflow_list_by_family(family_id)
in_use = next(m for m in models if m.state is ECMWorkflowFamilyModelState.IN_USE)
print(in_use.localised_names.get("de_DE", in_use.name))
from ecmind_blue_client.ecm import ECMWorkflowFamilyModelState

models = await ecm.workflow.workflow_list_by_family(family_id)
in_use = next(m for m in models if m.state is ECMWorkflowFamilyModelState.IN_USE)
print(in_use.localised_names.get("de_DE", in_use.name))

5. Siehe auch

  • projects() — die Familien einer Organisation

  • workflow_list() — die startbaren Workflows eines Benutzers

  • export() — ausgewählte Modelle über ihre IDs exportieren