Mailbox Evaluate All Automatic Routing Rules Service

Mailbox Evaluate All Automatic Routing Rules service evaluates all messages added to Sterling Integrator Mailbox against the routing rules since the previous evaluation.

The following table provides an overview of the Mailbox Evaluate All Automatic Routing Rules service:

Category Description
System name Mailbox Evaluate All Automatic Routing Rules Service
Graphical Process Modeler (GPM) category None
Description Evaluates all automatic routing rules. Automatic routing rules are evaluated against all messages added to Sterling Integrator Mailbox since the previous evaluation. Messages are eligible for automatic routing rule evaluation only once. If a message is added to a mailbox and is not targeted by an automatic routing rule, that message will never be eligible again for automatic routing rule processing, even if an automatic routing rule is later created that would target the message. Messages added successfully to a mailbox are processed by the automatic routing rules even if the Sterling B2B Integrator system fails and requires restarting.
Business usage Create Mailbox routing rules and designate some of them to be automatic. All automatic routing rules are periodically evaluated by this service.
Usage example The Sterling B2B Integrator Mailbox system administrator creates a new automatic routing rule. The preconfigured version of the Mailbox Evaluate All Automatic Routing Rules service is enabled. The rule is automatically evaluated every minute. If a message arrives in the specified mailbox, the rule is triggered.
Preconfigured? Yes
Requires third-party files? No
Platform availability All supported Sterling B2B Integrator platforms
Related services The Mailbox Evaluate All Automatic Routing Rules service works with the other Sterling B2B Integrator Mailbox services to provide mailboxing capability:
  • Mailbox Add service – Enables the insertion of messages into a mailbox.
  • Mailbox Extract Begin service – Enables the extraction of messages from a mailbox.
  • Mailbox Extract Commit service – Provides the ability for a business process to signal Sterling B2B Integrator Mailbox that the message extract request has successfully completed.
  • Mailbox Extract Abort service – Enables a business process to signal a failed message extraction to Sterling B2B Integrator Mailbox.
  • Mailbox Query service – Enables querying messages.
  • Mailbox Delete service – Enables deletion of messages.
  • Mailbox Evaluate Routing Rule service – Enables triggering of mailbox routing rules from a business process.
Application requirements Nothing external to Sterling B2B Integrator is required to use this service.
Initiates business processes? No
Invocation Not applicable (Internal service)
Business process context considerations None
Returned status values Returned status values:
  • Success – Normal completion.
  • Error – A generic error occurred.
Restrictions This service has no restrictions.
Testing considerations Troubleshooting information for this service can be found in Sterling B2B Integrator Mailbox log files.

How the Mailbox Evaluate All Automatic Routing Rules Service Works

Sterling B2B Integrator Mailbox uses the Mailbox Evaluate All Automatic Routing Rules service to automatically evaluate all automatic routing rules for messages that have not been routed. This service is disabled by default. You must enable it before it can be used.

Implementing the Mailbox Evaluate All Automatic Routing Rules Service

To implement the Mailbox Evaluate All Automatic Routing Rules service for use in a business process:
  1. Create a Mailbox Evaluate All Automatic Routing Rules service configuration. For information, see Managing Services and Adapters.
  2. Configure the Mailbox Evaluate All Automatic Routing Rules service. For information, see Configuring the Mailbox Evaluate All Automatic Routing Rules Service.
  3. Use the Mailbox Evaluate All Automatic Routing Rules service in a business process.

Configuring the Mailbox Evaluate All Automatic Routing Rules Service

To configure the Mailbox Evaluate All Automatic Routing Rules service, you must specify settings for the following fields in Sterling B2B Integrator:

Note: The field names in parentheses represent the corresponding field names in the GPM. This information is provided for your reference.
Field Description
Name Unique and meaningful name for the service configuration. Required.
Description Meaningful description for the service configuration, for reference purposes. Required.
Select a Group Select one of the options:
  • None – You do not want to include this configuration in a group at this time.
  • Create New Group – You can enter a name for a new group in this field, which will then be created along with this configuration.
  • Select Group – If you have already created one or more groups for this service type, they are displayed in the list. Select a group from the list.
Mailbox Routing Rule(RuleId) A valid ID for a routing rule. Required.
Run as User Enter (or select from the list) the user ID to be associated with business process instances of this service.
Use 24 Hour Clock Display If selected, the adapter will use the 24-hour clock instead of the default 12-hour clock.
Schedule Information about scheduling the service configuration to run. Valid values:
  • Do not use schedule

    If this field is selected, this service does not start a business process and does not run on a schedule.

  • Run based on timer

    Valid values are the hour and minutes at which to run the service. Indicate whether you want the service to run at startup.

  • Run daily

    Valid values are the hour and minutes at which to run the service, daily. You can also specify a time interval. Indicate whether you want the service to run at startup.

  • Run based on day(s) of the week

    Valid values are the day of the week, the hour, and the minutes at which to run the service. You can also specify a time interval. Indicate whether you want the service to run at startup.

  • Run based on day(s) of the month

    Valid values are the day of the month (including the last day of the month (LDOM)), hour, and the minutes at which to run the service. You can also specify a time interval. Indicate whether you want the service to run at startup.