ecmind-blue-client 0.3.1

A client wrapper for blue

ECMind blue client

A client wrapper for blue.

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