Skip to main content

This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Previous sectionNext section

Settings in All Business Services

Provides reference information for settings that are available in most or all business services.


All business services have the following settings:

Adapter Class Name

Common to business services and business operations. The class name for the inbound adapter associated with this business host, if any. This field is read-only and is determined by the business host class definition.

Adapter Description

Common to business services and business operations. Comments that describe the adapter class. This field is read-only and displays the first line of the class annotation in the code.

Alert Grace Period

Business processes and operations have a similar setting.

Alert On Error

Archive IO

Business Partner

A business partner profile is information about an organization or application connected to your Ensemble system. For each business partner, you can provide information such as the partner name, notes, primary and alternative contacts, and contact details. Defining a profile has no effect on the behavior or running of the production. It simply gives you a means to store more information.

For example, suppose your production talks to ABC Hospital and XYZ Hospital. You can enter profiles for both of these along with contact information. When you configure items that communicate with these organizations, you can specify the defined business partner for each business host.

For information on defining these profiles, see “Configuring Business Partners,” earlier in this book.


Common to all business hosts. An optional text label that you can use to visually group business hosts within the production diagram. Category names are case-sensitive and can contain space characters.

The Category drop-down list contains all the categories that are used in the current production. Specify this setting as follows:

  • To specify one category, either type the category name or select it from the Category drop-down list. If you type a category name and it does not yet exist, Ensemble creates it.

  • To specify multiple categories, select the check box for each desired category from the Category drop-down list. Or type a comma-separated list of categories.

To delete a category, remove that category selection from all business hosts that use it. If the Category drop-down list still displays the category, that means that the category is still in use. In this case, filter the display to show only business hosts that use that category (see “Filtering the Display by Category,” earlier in this book). Then for each of the business hosts that you see, edit the Category to remove the category.

Class Name

Common to all business hosts. The business host class name. This field is read-only.


Common to all business hosts. An optional text description.


Common to all business hosts. Comments that describe the business host class. This field is read-only and displays the first line of the class annotation in the code.


Common to all business hosts. Enables the business host, so that it processes messages whenever the production runs. You can also double-click a business host in the diagram to toggle between enabling and disabling it.

When the Enabled check box is clear, the business host is still present in the configuration, and its queue continues to accept messages, but none of these messages are processed until the business host is enabled again.

This setting is useful, for example, if there is a communications breakdown on the external side. For example, if an email server goes down, or something similar happens, you can disable the associated business service until throughput is restored.


Common to business services and operations. By default, this check box is clear. Select it for debugging or diagnostic purposes only. Jobs in operational systems almost never run in the foreground. When you select the Foreground check box, any system jobs used by the business service run in a Terminal window at the front of the console display. This allows Ensemble to display debugging or trace messages in that window. See “Testing and Debugging Productions” in Developing Ensemble Productions.

Generate SuperSession ID

This property controls whether the message will have a SuperSessionID, which can be used to identify messages that cross from one namespace to another. If this property is set, the business service first checks the inbound message for a SuperSession ID. If it has a SuperSessionID value, it uses it; otherwise, it generates a new SuperSession value. It sets the SuperSesssion value in the Ensemble message and can also return the value in any response it sends to the caller. The HTTP business services, including the SOAP business service, define how the SuperSessionID is passed in the HTTP headers and handle the SuperSessionID without custom code. For other business services, you must define how the SuperSessionID is represented in the external message and implement the OnGenerateSuperSession callback to process it.

Inactivity Timeout

The default value is 0 (zero). If this setting is 0, the business host will never be marked Inactive, no matter how long it stands idle.

Log Trace Events

By default, the Log Trace Events check box is clear. When selected, it enables logging of all trace messages issued by this business host. Logging means that Ensemble writes the trace messages to the console Terminal window (if your job is running in the foreground) and it also stores copies of these messages in the Event Log.

Pool Size

Notes specific to business services:

  • For business services, the default is 1.

  • You must use a value of 0 if the business service is being invoked via the Ens.Director method CreateBusinessService(); this is called an adapterless business service.

  • You may use a value greater than 1 with File or FTP inbound adapters if you want multiple jobs competing to pull files from the same input directory, or if you have a TCP Service configured with an exclamation point (!) to make it initiate the connection.

For a full discussion of appropriate pool sizes for different types of production, see the reference section “Pool Size and Actor Pool Size.”


Common to all business hosts. An optional command string that schedules stop and start times for the business host. The string is a comma-separated list of event specifications, each of which has the following format:


Where action is either START or STOP to indicate the desired event. Type a schedule string or select an existing schedule specification.

For details on the schedule string, see “Configuring Schedule Specifications,” earlier in this book.

Throttle Delay

For a business service, the delay occurs before each call to the adapter's OnTask() method. For a business operation, the delay occurs before each attempt to dequeue a new message.

This setting does not apply to SOAP services in CSP mode and other services invoked externally via CreateBusinessService(). It applies on a per-job basis so that operations with Pool Size greater than 1 and services with JobPerConnection as true can still generate multiple messages within the interval.