checkin()

Checkt ein Dokument ein über DMS.CheckInDocument. Gibt die Checkout-Sperre frei und ersetzt die Dateien des Dokuments durch die übergebenen Dateien. Das Dokument muss zuvor über checkout() ausgecheckt worden sein.

1. Signatur

  • Sync

  • Async

ecm.dms.checkin(
    model: ECMDocumentModel | int,
    files: list[JobRequestFile],
    object_type_id: int | None = None,
    *,
    allow_other_station: bool = False,
) -> None
await ecm.dms.checkin(
    model: ECMDocumentModel | int,
    files: list[JobRequestFile],
    object_type_id: int | None = None,
    *,
    allow_other_station: bool = False,
) -> None

2. Parameter

Parameter Typ Standard Beschreibung

model

ECMDocumentModel | int

 — 

Entweder eine ECMDocumentModel-Instanz (deren id verwendet wird) oder eine numerische Dokument-ID.

files

list[JobRequestFile]

 — 

Liste der einzucheckenden Dateien. Mindestens eine Datei ist erforderlich.

object_type_id

int | None

None

Die numerische Objekttyp-ID. Bei None wird der Typ aus der Model-Instanz übernommen, sofern verfügbar, oder über get_object_type_by_id() für numerische IDs aufgelöst.

allow_other_station

bool

False

Bei True darf das Dokument von einer anderen Station eingecheckt werden als der, die es ausgecheckt hat.

3. Ausnahmen

Ausnahme Bedingung

ValueError

model ist eine ECMDocumentModel-Instanz mit id gleich None.

ECMNotFoundException

object_type_id ist None und es existiert kein Objekt mit der angegebenen ID auf dem Server.

ECMWrongStateException

Das Dokument ist nicht ausgecheckt oder wurde von einem anderen Benutzer ausgecheckt (bei allow_other_station=False).

4. Beispiele

4.1. Auschecken, bearbeiten und einchecken

  • Sync

  • Async

from ecmind_blue_client.rpc import JobRequestFileFromBytes

# Dokument auschecken
ecm.dms.checkout(doc_id, doc_type_id)

# ... Dateiinhalt bearbeiten ...

# Mit aktualisierter Datei einchecken
ecm.dms.checkin(doc_id, [JobRequestFileFromBytes(b"Aktualisierter Inhalt", "txt")], doc_type_id)
from ecmind_blue_client.rpc import JobRequestFileFromBytes

await ecm.dms.checkout(doc_id, doc_type_id)

# ... Dateiinhalt bearbeiten ...

await ecm.dms.checkin(doc_id, [JobRequestFileFromBytes(b"Aktualisierter Inhalt", "txt")], doc_type_id)

4.2. Einchecken von einer anderen Station

  • Sync

  • Async

ecm.dms.checkin(doc_id, [JobRequestFileFromBytes(b"Inhalt", "txt")], allow_other_station=True)
await ecm.dms.checkin(doc_id, [JobRequestFileFromBytes(b"Inhalt", "txt")], allow_other_station=True)

5. Siehe auch

  • checkout() — Dokument zum Bearbeiten sperren

  • undo_checkout() — Sperre aufheben ohne einzuchecken

  • files() — Dateien eines Dokuments herunterladen

  • history() — Änderungshistorie mit Versionseinträgen anzeigen