Yanked
This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 1.0.0 instead.
Reason given by maintainers: TLS certificate missmatch with Python <=3.10
ECMind blue client
A client wrapper for blue.
Deprecation warning
- From Mai 2024,
ecmind_blue_client.com_clientis no longer supported nor tested. - From Mai 2024,
ecmind_blue_client.soap_clientis 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 moduleecmind_blue_client.soap_client: Connect with a SOAP connection stringComClient()in the moduleecmind_blue_client.com_client: Connect by using the COM class on WindowsTcpClient()in the moduleecmind_blue_client.tcp_client: Directly talk to a server via protlib.- Use
TcpClient.Connection()in a with block/context.
- Use
TcpPoolClient()in the moduleecmind_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_codereturns the blue result coderesult.valuesis a dict of output parametersresult.filesis a list of output file parametersresult.error_messagesis a string of the servers error response or None ifresult_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)
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ecmind_blue_client-0.8.1.dev8.tar.gz.
File metadata
- Download URL: ecmind_blue_client-0.8.1.dev8.tar.gz
- Upload date:
- Size: 44.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ae5e9e609cdcd57089265dd0ec1839441df1e477b7c6bf6e46ee121761085d89
|
|
| MD5 |
391a5486311b5c0acc1c1676b4b2e169
|
|
| BLAKE2b-256 |
162cec42f304c9d02f9b91c498970e0c63f39d826b0b9d367cb33eaae4f670de
|
File details
Details for the file ecmind_blue_client-0.8.1.dev8-py3-none-any.whl.
File metadata
- Download URL: ecmind_blue_client-0.8.1.dev8-py3-none-any.whl
- Upload date:
- Size: 44.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
09bd8d5e6c83f30f30f56d2e66a14a41f31e6c50410615eaff65f19cda44cced
|
|
| MD5 |
cc62231525624522dc3b52cd375f96a5
|
|
| BLAKE2b-256 |
54f971c5dd21f04384b8c779f338b9041ccdd0e75e5bcd1076f0757ebab195da
|
