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

obj

int | ECMWorkspaceDocument | Modellinstanz

Das DMS-Objekt: seine numerische ID, ein ECMWorkspaceDocument oder eine geladene typisierte Modellinstanz, deren system.id gelesen wird.

organisation

str | ECMOrganisation | None

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

user

str | ECMOrganisationObject | ECMOrganisationObjectRef | None

Optionaler Workflow-Organisationsbenutzer. Mit Angabe sagt is_process_responsible je Prozess, ob dieser Benutzer einer seiner Prozessverantwortlichen ist. Ohne Angabe ist das Flag immer False. Das ist die Workflow-Organisations-GUID, nicht die Benutzer-ID des Sicherheitssystems.

all_processes

bool

False (Serverstandard) listet nur laufende Prozesse. True nimmt beendete Prozesse aus der Historie dazu.

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 Status 16 (TERMINATED) und leerem activities-Tupel.

  • activities enthält die Aktivitäten, die gerade ein Work-Item haben. Unmittelbar nach start_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 Status 64 und ohne Owner.

  • Eine unbekannte, leere oder fremde user-GUID wird akzeptiert und ergibt schlicht is_process_responsible = False.

3.1. Felder von ECMObjectProcess

Feld Typ Beschreibung

id

str

GUID der Prozessinstanz (Id).

name

str

Instanzname des Prozesses (Name).

subject

str

Betreff des Prozesses (Subject), leer wenn nicht gesetzt.

state

int

Roher Prozessstatus (State): 1 INIT, 2 RUNNING, 4 SUSPENDED, 8 ACTIVE, 16 TERMINATED, 32 COMPLETED, 64 SYSSUSPENDED.

creator_id

str

GUID des Workflow-Organisationsbenutzers, der den Prozess gestartet hat (CreatorId).

creator_name

str

Anzeigename dieses Benutzers (CreatorName).

created_at

datetime | None

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

is_process_responsible

bool

True, wenn der an die Abfrage übergebene user Prozessverantwortlicher dieses Prozesses ist (ProcessResponsible).

activities

tuple[ECMObjectProcessActivity, …​]

Die Aktivitäten, die gerade ein Work-Item haben. Leer bei beendeten Prozessen und kurz nach dem Start.

localised_names

Mapping[str, str]

Instanzname je Locale, aufgelöst aus dem <Resources>-Block über ProcessNameResId.

localised_subjects

Mapping[str, str]

Betreff je Locale, aufgelöst über ProcessSubjectResId.

3.2. Felder von ECMObjectProcessActivity

Feld Typ Beschreibung

name

str

Technischer Aktivitätsname (Name).

state

int

Rohe Aktivitätsstatus-Bitmaske (State): 128 personalisiert, 64 nicht personalisiert.

ended_at

datetime | None

Endzeit als UTC-datetime (EndTime). None, solange die Aktivität läuft.

owner

str

Name des Benutzers, der die Aktivität gerade besitzt (Owner), leer wenn niemand sie übernommen hat.

owner_id

str

GUID des besitzenden Benutzers (OwnerId), leer wenn niemand sie übernommen hat.

performers

tuple[ECMObjectProcessPerformer, …​]

Die Organisationsobjekte, an die die Aktivität adressiert ist (<Objects>).

localised_names

Mapping[str, str]

Aktivitätsname je Locale, aufgelöst über ActivityNameResId.

3.3. Felder von ECMObjectProcessPerformer

Feld Typ Beschreibung

id

str

GUID des Workflow-Organisationsobjekts (Id).

name

str

Anzeigename des Organisationsobjekts (Name).

email

str

E-Mail-Adresse (EMail), leer wenn nicht gesetzt.

is_user

bool

True für ein Benutzerobjekt, False für Rolle oder Gruppe (User).

absent

bool

True, wenn der Benutzer abwesend gemeldet ist (Absent).

substitute

bool

True, wenn der Eintrag ein Stellvertreter des eigentlichen Bearbeiters ist (Substitute).

flags

int

Rohe Bearbeiter-Flags (Flags); 7 gemessen für einen gewöhnlichen Benutzer-Bearbeiter.

Das Serverhandbuch dokumentiert nur flache Attribute an <Process>. Gemessen auf enaio 12.0 trägt die Antwort zusätzlich CreatorName, den <Activities>-Block mit den Bearbeitern jeder Aktivität, die *ResId-Attribute und einen abschliessenden <Resources>-Block mit den lokalisierten Texten je Locale. Der Client bildet alles ab; die Ressourcen-IDs werden nicht nach aussen gegeben.

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