ecmind-blue-client

ecmind-blue-client ist eine Python-Bibliothek (Python >= 3.12), die den Zugriff auf ECMind Blue Server über das proprietäre TCP/RPC-Protokoll kapselt.

Die Bibliothek stellt drei Abstraktionsebenen bereit:

RPC-Ebene

Direkter TCP-Socket-Zugriff auf den Server. Serialisiert Job-Parameter in das proprietäre Binärprotokoll.
Pool-Client

Empfohlene Verbindungspools (SyncPoolClient / AsyncPoolClient) mit gewichtetem Load-Balancing über mehrere Server.
ECM-API

Objektorientierte Hochsprach-API für Ordner, Register und Dokumente sowie Datenbankzugriff.

1. Verfügbare Namespaces

Nach der Initialisierung über die ECM()-Factory stehen folgende Namespaces zur Verfügung:

Namespace Beschreibung

ecm.dms

Objekt-Operationen: Ordner, Register, Dokumente — Suchen, Anlegen, Bearbeiten, Löschen

ecm.security

Benutzer- und Gruppenverwaltung

ecm.system

Server-Metadaten und Objektdefinitionen

ecm.db

Direkter SQL-Zugriff über ADO (ado.ExecuteSQL)

2. Sync und Async

Alle Namespaces sind vollständig sowohl synchron als auch asynchron verfügbar. Das Übergeben eines SyncPoolClient an ECM() liefert eine synchrone Instanz zurück, ein AsyncPoolClient liefert die asyncio-basierte Variante.

  • Sync

  • Async

from ecmind_blue_client.ecm import ECM
from ecmind_blue_client.pool import SyncPoolClient

client = SyncPoolClient(servers="<host>:4000:1", username="<username>", password="<password>")
ecm = ECM(client)
from ecmind_blue_client.ecm import ECM
from ecmind_blue_client.pool import AsyncPoolClient

client = AsyncPoolClient(servers="<host>:4000:1", username="<username>", password="<password>")
ecm = ECM(client)