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 |
|---|---|---|
|
|
Die Familie als GUID oder als |
|
|
Die Organisation als GUID oder als |
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 |
|---|---|---|
|
|
GUID des Workflowmodells ( |
|
|
Technischer Modellname ( |
|
|
Modellstatus ( |
|
|
GUID des Erstellers ( |
|
|
Erstellzeit als UTC- |
|
|
Versionsnummer des Modells innerhalb der Familie ( |
|
|
GUID des Benutzers, der die Bearbeitungssperre hält ( |
|
|
Name des Benutzers, der die Bearbeitungssperre hält ( |
|
|
Zeitpunkt der Sperre als UTC- |
|
|
Beschreibung des Modells ( |
|
|
Icon-ID des Modells ( |
|
|
Anzeigename je Locale, z. B. |
|
|
Beschreibung je Locale, aufgelöst über |
3.2. Werte von ECMWorkflowFamilyModelState
| Member | Wert | Bedeutung |
|---|---|---|
|
|
Das Modell ist in Benutzung: Neue Prozesse können daraus gestartet werden. Genau eines je Familie. |
|
|
Das Modell ist für die Bearbeitung gesperrt. |
|
|
Das Modell wird bearbeitet, ist aber nicht gesperrt. |
|
|
Das Modell ist zum Test freigegeben. |
|
|
Das Modell ist gelöscht, aber noch in der Datenbank enthalten. |
|
|
Das Modell ist freigegeben, aber nicht in Benutzung: keine neuen Prozesse, laufende werden noch beendet. |
|
Das Serverhandbuch dokumentiert nur die Attribute von |
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