process_list_by_object()
Liefert die Workflowprozesse, deren Akte ein bestimmtes DMS-Objekt enthält, über
wfm.GetProcessListByObject.
1. Signatur
-
Sync
-
Async
ecm.workflow.process_list_by_object(
obj: int | ECMWorkspaceDocument | ECMFolderModel | ECMRegisterModel | ECMDocumentModel,
organisation: str | ECMOrganisation | None = None,
*,
user: str | ECMOrganisationObject | ECMOrganisationObjectRef | None = None,
all_processes: bool = False,
) -> list[ECMObjectProcess]
await ecm.workflow.process_list_by_object(
obj: int | ECMWorkspaceDocument | ECMFolderModel | ECMRegisterModel | ECMDocumentModel,
organisation: str | ECMOrganisation | None = None,
*,
user: str | ECMOrganisationObject | ECMOrganisationObjectRef | None = None,
all_processes: bool = False,
) -> list[ECMObjectProcess]
2. Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
|
|
Das DMS-Objekt: seine numerische ID, ein |
|
|
Die Organisation als GUID oder als |
|
|
Optionaler Workflow-Organisationsbenutzer. Mit Angabe sagt |
|
|
|
3. Rückgabewert
Eine Liste von ECMObjectProcess in Serverreihenfolge. Leere Liste, wenn kein Prozess das
Objekt in seiner Akte hat.
Gemessen auf enaio 12.0:
-
Eine unbekannte Objekt-ID ist kein Fehler; der Server antwortet mit
<Processes><Resources/></Processes>, also einer leeren Liste. -
Beendete Prozesse erscheinen nur mit
all_processes=True, mit Status16(TERMINATED) und leeremactivities-Tupel. -
activitiesenthält die Aktivitäten, die gerade ein Work-Item haben. Unmittelbar nachstart_process()ist das Tupel noch leer, bis die Engine das erste Work-Item angelegt hat, rund drei Sekunden später; die Aktivität erscheint dann mit Status64und ohne Owner. -
Eine unbekannte, leere oder fremde
user-GUID wird akzeptiert und ergibt schlichtis_process_responsible = False.
3.1. Felder von ECMObjectProcess
| Feld | Typ | Beschreibung |
|---|---|---|
|
|
GUID der Prozessinstanz ( |
|
|
Instanzname des Prozesses ( |
|
|
Betreff des Prozesses ( |
|
|
Roher Prozessstatus ( |
|
|
GUID des Workflow-Organisationsbenutzers, der den Prozess gestartet hat ( |
|
|
Anzeigename dieses Benutzers ( |
|
|
Startzeit als UTC- |
|
|
|
|
|
Die Aktivitäten, die gerade ein Work-Item haben. Leer bei beendeten Prozessen und kurz nach dem Start. |
|
|
Instanzname je Locale, aufgelöst aus dem |
|
|
Betreff je Locale, aufgelöst über |
3.2. Felder von ECMObjectProcessActivity
| Feld | Typ | Beschreibung |
|---|---|---|
|
|
Technischer Aktivitätsname ( |
|
|
Rohe Aktivitätsstatus-Bitmaske ( |
|
|
Endzeit als UTC- |
|
|
Name des Benutzers, der die Aktivität gerade besitzt ( |
|
|
GUID des besitzenden Benutzers ( |
|
|
Die Organisationsobjekte, an die die Aktivität adressiert ist ( |
|
|
Aktivitätsname je Locale, aufgelöst über |
3.3. Felder von ECMObjectProcessPerformer
| Feld | Typ | Beschreibung |
|---|---|---|
|
|
GUID des Workflow-Organisationsobjekts ( |
|
|
Anzeigename des Organisationsobjekts ( |
|
|
E-Mail-Adresse ( |
|
|
|
|
|
|
|
|
|
|
|
Rohe Bearbeiter-Flags ( |
|
Das Serverhandbuch dokumentiert nur flache Attribute an |
4. Beispiele
4.1. Prozesse eines Dokuments
-
Sync
-
Async
for process in ecm.workflow.process_list_by_object(document_id):
owners = ", ".join(a.owner or "-" for a in process.activities)
print(f"{process.name} ({process.state}) bei {owners}")
for process in await ecm.workflow.process_list_by_object(document_id):
owners = ", ".join(a.owner or "-" for a in process.activities)
print(f"{process.name} ({process.state}) bei {owners}")
4.2. Mit beendeten Prozessen, aus einem geladenen Modell
-
Sync
-
Async
document = ecm.dms.get(Rechnung, document_id)
processes = ecm.workflow.process_list_by_object(document, all_processes=True)
ended = [p for p in processes if p.state & 16]
document = await ecm.dms.get(Rechnung, document_id)
processes = await ecm.workflow.process_list_by_object(document, all_processes=True)
ended = [p for p in processes if p.state & 16]
4.3. Verantwortung eines Benutzers
-
Sync
-
Async
user = ecm.workflow.organisation_user_by_login("root")
for process in ecm.workflow.process_list_by_object(document_id, user=user):
print(process.name, process.is_process_responsible)
user = await ecm.workflow.organisation_user_by_login("root")
for process in await ecm.workflow.process_list_by_object(document_id, user=user):
print(process.name, process.is_process_responsible)
5. Siehe auch
-
process_list_by_user()— die Prozesse im Eingangskorb eines Benutzers -
start_process()— einen Prozess mit Dokumenten in der Akte starten -
organisation_objects()— Workflow-Organisationsbenutzer auflösen