Mailbox Evaluate Routing Rule Service

The Mailbox Evaluate Routing Rule service evaluates a mailbox routing rule.

The following table provides an overview of the Mailbox Evaluate Routing Rule service.

Category	Description
System name	Mailbox Evaluate Routing Rule Service
Graphical Process Modeler (GPM) categories	All Services, Internet B2B > Mailbox
Description	Evaluates a mailbox routing rule.
Business usage	Create a specific routing rule then use the Mailbox Evaluate Routing Rule service to schedule evaluation of that rule. This allows business processes to use routing rules. This service can be scheduled.
Usage example	The Sterling B2B Integrator Mailbox system administrator creates several automatic Mailbox Routing Rules that target specific mailboxes to execute specific business processes. This service evaluates those routing rules on a schedule established by the system administrator using the Mailbox Evaluate Routing Rule service.
Preconfigured?	Yes
Requires third-party files?	No
Platform availability	All supported Sterling B2B Integrator platforms
Related services	The Mailbox Evaluate Routing Rule 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 All Automatic Rules service – Provides for the scheduling of automatic routing rules for Sterling B2B Integrator Mailbox.
Application requirements	Nothing external to Sterling B2B Integrator is required to use this service.
Initiates business processes?	No
Invocation	This service can be scheduled. It also can be started by business processes wanting to trigger a Mailbox routing rule.
Business process context considerations	No
Returned status values	Returned status values: Success – Normal completion. Invalid Rule ID Error – The target ruleid could not be evaluated. Mailbox Router Error – A generic error associated with the mailbox router occurred. Mailbox service Error – A generic error associated with the mailbox service occurred.
Restrictions	The limitations of this service are based on the assignment of mailbox permissions to users and groups.
Testing Considerations	Troubleshooting for this services can be found in the Sterling B2B Integrator Mailblox log files.

How the Mailbox Evaluate Routing Rules Service Works

Use the Mailbox Evaluate Routing Rule service to evaluate a routing rule that is defined in Sterling B2B Integrator Mailbox. The evaluation can be scheduled.

Implementing the Mailbox Evaluate Routing Rule Service

To implement the Mailbox Evaluate Routing Rule service for use in a business process:

Create a Mailbox Evaluate Routing Rule service configuration.
Configure the Mailbox Evaluate Routing Rule service.
Use the Mailbox Evaluate Routing Rule service in a business process.

Configuring the Mailbox Evaluate Routing Rule Service

To configure the Mailbox Evaluate Routing Rule service, 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 if RuleDescription is not provided.
RuleDescription	A description that uniquely identifies the routing rule for this service. Unlike RuleId, RuleDescription does not change as the result of an import. If set, RuleDescription takes precedence over RuleId and RuleId is ignored. Required if RuleId is not provided.
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.

GPM Configuration

The following table describes the fields used to configure the Mailbox Evaluate Routing Rule service in the GPM:

Field	Description
Config	Name of the service configuration.
RuleId	A valid ID for a routing rule. Required if RuleDescription is not providec.

Parameters Passed from Business Process to Service

Parameter	Description
RuleId	ID of the routing rule that was evaluated.
RuleDescription	A description that uniquely identifies the routing rule for this service. Unlike RuleId, RuleDescription does not change as the result of an import. If set, RuleDescription takes precedence over RuleId and RuleId is ignored. Required if RuleId is not provided.

Output from Service to Business Process

The following table contains the parameter passed from the Mailbox Evaluate Routing Rule service to a business process:

Parameter	Description
RuleId	ID of the routing rule that was evaluated.
MessageId	An ID of each of the Messages that were evaluated against rule with RuleId.

Business Process Example

The following BPML evaluates the rule corresponding to ruleId = 268ef9:f6af57c58f:-72bf:

<process name="LaunchAcmeRoutingRule">
    <sequence name="Evaluate">
    <!—Evaluate the AcmeRoutingRule -->
        <operation name="Mailbox Evaluate Routing Rule Service">
           <participant name="MailboxEvaluateRoutingRule"/>
          <output message="EvaluateRuleRequest">
             <assign to="." from="*"></assign>
             <assign to="RuleId">268ef9:f6af57c58f:-72bf </assign>
          </output>
           <input message="inmsg">
               <assign to="EvaluateRuleResults" from="*"></assign>
          </input>
       </operation>
   </sequence> 
</process>