Skip to main content

A client wrapper for blue

Project description

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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ecmind_blue_client-0.8.1.tar.gz (44.3 kB view details)

Uploaded Source

Built Distribution

ecmind_blue_client-0.8.1-py3-none-any.whl (44.7 kB view details)

Uploaded Python 3

File details

Details for the file ecmind_blue_client-0.8.1.tar.gz.

File metadata

  • Download URL: ecmind_blue_client-0.8.1.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

Hashes for ecmind_blue_client-0.8.1.tar.gz
Algorithm Hash digest
SHA256 ff6b6189fe6b6b990041fa76d17c6f1d8d2edda6ddd8dbeb23f6ee21cff6c5d2
MD5 2d9cfec0203dd9f87695fe6dd64750b8
BLAKE2b-256 05c5e8ef8421370a08185c4131f5e1023eeaffc913932a7f4f651e73165640e8

See more details on using hashes here.

File details

Details for the file ecmind_blue_client-0.8.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ecmind_blue_client-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8e533ac7137214314c3d90edbebe67c5e8f91534424ea3287f399215f1d9291f
MD5 465b3ace3320fcd06294f48750e694fa
BLAKE2b-256 8cb6e8158a518a6117a313c05156c7a1433b03bd95d52bc952f57a675b0c9575

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page