Settings in All Business Processes

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

Summary

All business processes have the following settings:

Group	Settings	Notes
Informational Settings	Comment, Category, Class Name, Description, Business Partner	See these settings for business services
Basic Settings	Enabled	See this setting for business services
Additional Settings	Schedule,	See this setting for business services
Additional Settings	Pool Size, Reply Code Actions,
Alerting Control	Alert Retry Grace Period, Queue Count Alert, Queue Wait Alert
Alerting Control	Alert On Error, Inactivity Timeout	See these settings for business services
Development and Debugging	Log Trace Events	See this setting for business services

Alert Retry Grace Period

Common to business processes and operations. Specifies an optional grace period during which errors relating to external connections do not trigger alerts (even if Alert On Error is True).

If the error condition still exists after the alert period expires, the business operation triggers an alert; otherwise no alert is triggered.

Business services have a similar setting.

Pool Size

Common to all business hosts. See this setting for business services.

Notes specific to business processes:

A business process shows no pool size if its private pool size is 0 (zero), meaning that it gets its jobs from the public actor pool shared by all business processes in the production.
This number could be larger to allow higher throughput in some circumstances. If this number is 0, the business process has no private pool of jobs, and uses jobs from the public actor pool for the production.
Larger numbers are not necessarily helpful; while the potential pool sizes actually range from 0–100, most pool sizes are best set to either 0 or 1, and there can be serious consequences when sizes are set to a number greater than 1.

Important:

When you disable a business process, it must have a Pool Size = 1 or greater if you want all instances of only this business process to stop. If the business process has a Pool Size = 0, the action disables all business processes that share the actor pool. See the reference section “Pool Size and Actor Pool Size.”

Queue Count Alert

Common to business processes and operations. Specifies an alert threshold for the number of items in the queue of this business host.

Ensemble sends an alert when the number of items in a business host’s queue reaches the threshold set by this setting for that business host. This alert has the prefix QueueCountAlert: (not localized). This alert is to detect large queues that are building up.

The service that checks the queue count runs every five seconds, so the granularity of the checking is somewhat limited, but should still provide timely warnings about processing and flow problems.

To disable this alert, specify this setting as 0.

For information on alerts, see “Configuring Alerts.”

Queue Wait Alert

Common to business processes and operations. Specifies an alert threshold for the wait time of the queue of this business host.

Ensemble sends an alert when a message has been in a business host’s queue for the length of time specified by this setting for that business host. This alert has the prefix QueueWaitAlert: (not localized). This alert is useful to detect whether a queue is processing messages.

The service that checks the wait periods runs every five seconds, so the granularity of the checking is somewhat limited, but should still provide timely warnings about processing and flow problems.

To disable this alert, specify this setting as 0.

For information on alerts, see “Configuring Alerts.”

Reply Code Actions

Common to business processes and business operations. Comma-separated list of code-action pairs, specifying which action the business process takes on receipt of various reply status conditions.

The Reply Code Actions setting allows you to supply a comma-separated list of code-action pairs, specifying which action the business host takes on receipt of various reply status conditions. The format of the list is:

code=actions,(code,code)=actions, ... code=action

The following table lists the types of reply status condition identified by code.

Code	Meaning
E	Error status returned from message handler.
E#statuscode	Error status returned from message handler has status code equal to statuscode.
E*text	Error status returned from message handler contains text string text.
X	There is no reply message object at all.

The following values for action may be used alone or combined to form strings.

Action	Meaning
C	Treat the document as Completed OK.
W	Log a warning but treat the document as Completed OK.
R	Retry the message according to the configured Retry Interval and Failure Timeout settings; finally Fail, unless a different action is also specified.
S	Suspend the message, log an error, and move on to try the next message (the default).
D	Disable the business process or operation, log an error, and restore the outbound message to the front of the business host queue. When you choose the disable action for a business process, you must configure the business with a Pool Size = 1 or greater if you want all instances of only this business process to stop. If the business process has a Pool Size = 0, the disable action disables all business processes that share the actor pool. See “Pool Size and Actor Pool Size.”
F	Fail with an error and move on to try the next message.

For example:

E#6301=R,E*ErrGeneral=R,E=F

The default value for the Reply Code Actions string is:

E=F

Which means when there is an error, fail and move on to try the next message.

All codes where the actions consists of only W (log a Warning) are evaluated and warnings generated if they trigger. Other codes are evaluated in left-to-right order, executing the first one that triggers that has a non-warning actions value. For example if the reply code action has the value E=RD, the business process or operation first retries to send the message until Failure Timeout setting and then, if the failure continues, it disables the business process or operation.