pyprod: Creating IRIS Interoperability Productions Programmatically with Python

In the previous article, we used pyprod to create production components while relying on the UI for production configuration. That same production can now be defined entirely in Python:

from intersystems_pyprod import Production, ServiceItem, ProcessItem, OperationItem

iris_package_name = "HelloWorld"

class MyProduction(Production):
    services = [
        ServiceItem(
            "MyServiceName",
            "HelloWorld.MyService",
            host_settings={"target": "MyProcessName"},
        )
    ]
    processes = [
        ProcessItem(
            "MyProcessName",
            "HelloWorld.MyProcess",
            host_settings={"target": "MyOperationName"},
        )
    ]
    operations = [
        OperationItem("MyOperationName", "HelloWorld.MyOperation")
    ]

Key parts of the code

• The Production class
  MyProduction subclasses Production, which tells pyprod that this class represents an interoperability production. Production-level settings such as actor_pool_size, testing_enabled, etc. can be set as class attributes.

• services, processes and operations lists
  When pyprod finds one of these attributes, it expects a list of ServiceItem, ProcessItem, or OperationItem objects. Each item represents one config entry that will be registered in the production backend, along with its unique instance settings.

• ServiceItem, ProcessItem and OperationItem
  These classes declare the business host class to add as a production component along with its instance-specific settings. Both Python and ObjectScript classes can be added this way.

• host_settings
  This dictionary sets the properties defined as IRISProperty on the python host class or the Property of an ObjectScript class. This is the programmatic equivalent of entering values in the Production Configuration page.

More options are available - adapter_settings, scheduling, pool size, enable/disable flags, and others - documented in the API Reference.

Load to IRIS 

To load this production into IRIS, point the CLI tool at the Python script containing it. The production definition can be at the end of the same file as your business host classes, or in a separate file:

$ intersystems_pyprod /path/to/MyProduction.py

Load-time validation
When you run the CLI command to load the production into IRIS, pyprod validates it on two levels. First, unknown attributes on the Production subclass emit a warning (catching typos as well). Second, all host_settings and adapter_settings key names are checked against the actual class definitions, with a warning emitted for any unrecognised property, catching configuration mistakes before the production runs.

Controlling the production programmatically

Once the production is loaded, you can start, inspect, and stop it using the director module from a Python shell or script

>>> from intersystems_pyprod import director
>>> director.start_production()
1
>>> director.get_production_status()
(1, 'HelloWorld.MyProduction', '1')
>>> director.stop_production()
1

You can also inspect messages that have passed through any host:

>>> messages = director.get_host_messages("MyServiceName", 100)
>>> messages[0]
{
    'id': '156',
    'time_created': '2026-06-02 19:34:10.545',
    'source': 'MyProcessName',
    'target': 'MyServiceName',
    'status': 9,
    'session_id': 153,
    'body_class': 'HelloWorld.MyResponse',
    'body_id': '27'
}

The full list of methods available in the director module is documented in the API Reference.

You can find an example of creating an adapterless business service here, and see how to test it using the director module in test_bo_method_1() here.