ECMind blue client

A client wrapper for blue.

Deprecation warning

From Mai 2024, ecmind_blue_client.com_client is no longer supported nor tested.
From Mai 2024, ecmind_blue_client.soap_client is no longer supported nor tested.

Installation

pip install ecmind_blue_client

Usage

The workflow consists roughly of the following:

Create a new Client() connection using a client implementation. There are four implementations:
- SoapClient() in the module ecmind_blue_client.soap_client: Connect with a SOAP connection string
- ComClient() in the module ecmind_blue_client.com_client: Connect by using the COM class on Windows
- TcpClient() in the module ecmind_blue_client.tcp_client: Directly talk to a server via protlib.
  - Use TcpClient.Connection() in a with block/context.
- TcpPoolClient() in the module ecmind_blue_client.tcp_pool_client
Create a new Job() with a job name and provide/add job input parameters and optional job input file parameters
Execute the Job() with the Client() instance and consume the result
- result.result_code returns the blue result code
- result.values is a dict of output parameters
- result.files is a list of output file parameters
- result.error_messages is a string of the servers error response or None if result_code == 0

>>> from ecmind_blue_client.soap_client import SoapClient
>>> client = SoapClient(self.endpoint, 'TestApp', 'root', 'optimal')
>>> test_job = Job('krn.GetServerInfo', Flags=0, Info=6)
>>> result = client.execute(test_job)
>>> print(result.values['Value'])
oxtrodbc.dll

Example

from ecmind_blue_client import SystemFields
from ecmind_blue_client.tcp_pool_client import TcpPoolClient as Client

# Connect with DMS
client = Client(
    connection_string="localhost:4000:100", # Balancing setup for the used Client class `TcpPoolClient`
    appname="Test-Script",                  # Instance name, visible in the enterprise manager
    username="root",
    password="optimal"
)

# Query a folder
query = client.lol_query(
    object_name="Dossier",
    result_fields=[
        SystemFields.OBJECT_CRDATE, 
        "LastName", 
        "FirstName"
    ]
)

# Iterate over folder results
for dossier in query:
    print(                                                 # Output some infos
        dossier["OBJECT_ID"],                              # OBJECT_ID is added per defaults
        dossier['OBJECT_CRDATE'].strftime("%Y-%m-%d"),     # Manually added system field from line 16
        (f"{dossier['FirstName']} {dossier['LastName']}"), # Manually added objdef fields from line 17 & 18
    )

# Check that we have found a least one folder
assert dossier and "OBJECT_ID" in dossier

# Import a test document into the last found folder
import_result = client.xml_import(
    object_name="Dokument", 
    folder_id=dossier["OBJECT_ID"], 
    search_fields={
        "Type": "Invoice"
    },
    import_fields={
        "Type": "Invoice"
    },
    files = ["invoice.pdf"]
)

# Check if the import was successful and output OSID
assert import_result, import_result.error_message
print(import_result.import_action, import_result.object_id)

License
- OSI Approved :: MIT License
Operating System
- OS Independent
Programming Language
- Python :: 3

Metadata

License
- OSI Approved :: MIT License
Operating System
- OS Independent
Programming Language
- Python :: 3

Release files for ecmind-blue-client 0.7.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ecmind-blue-client 0.7.4
File	Size	Uploaded
ecmind_blue_client-0.7.4.tar.gz	34.5 kB	Jan 6, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for ecmind-blue-client 0.7.4
File	Interpreter	ABI	Platform	Reset
ecmind_blue_client-0.7.4-py3-none-any.whl 42.3 kB Jan 6, 2025	Python 3	none	any	Details

Total release size: 76.8 kB

Release files / ecmind_blue_client-0.7.4.tar.gz

Download URL	ecmind_blue_client-0.7.4.tar.gz
Size	34.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`68f260f96d78b94be15849b69d10e527b95e6cbf2989c1d74c889272f8bad881`
BLAKE2b-256 checksum How to use checksums	`6bcf4c30f5d38809945c07727041d10c166c03e0fc4d5599c85862266ac37907`
Upload date	Jan 6, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.0 CPython/3.12.7`

Release files / ecmind_blue_client-0.7.4-py3-none-any.whl

Download URL	ecmind_blue_client-0.7.4-py3-none-any.whl
Size	42.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`5f7fee626c1e0a157267b44c67c3f8c60da843510dcdb2573b0077a96f984deb`
BLAKE2b-256 checksum How to use checksums	`ea4a8ad43bcfbcfddbc15af84dcc688d958d1974cb7f3d67af8c0221daa75494`
Upload date	Jan 6, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.0 CPython/3.12.7`