Mailbox Correlate Document Service

The Mailbox Correlate Document service correlates the specified document to three separate components of the specified message: the message name, the message ID, and the path of the mailbox.

The following table provides an overview of the Mailbox Correlate Document service:

Category Description
System name Mailbox Correlate Document Service
Graphical Process Modeler (GPM) category None
Description Correlates the specified document to three separate components of the specified message: the message name, the message ID and the path of the mailbox. The correlation names for each of these components are Mailbox_MessageName, Mailbox_MessageId, and Mailbox_MailboxPath. The correlation for mailbox path will contain the absolute path of the mailbox the message was added to.
Business usage This is a system service.
Usage example The business process MailboxAS2Add correlates a packaged (enveloped) AS2 document with the message and mailbox that the corresponding payload is destined to. This allows the EDIINT detail UI page to also display the message and mailbox that an AS2 transaction corresponds to.
Preconfigured? Yes
Requires third-party files? No
Platform availability All supported Sterling B2B Integrator platforms
Related services The Mailbox Correlate Document 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.
  • 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? None
Invocation Does not perform any permissions checking.
Business process context considerations No information from the business process except what is supplied through the normal BPML <operation> and <assign> syntax.
Returned status values Returned status values:
  • Success – Normal completion.
  • Invalid Mailbox Parameter Error – An error occurred passing parameters to this service such as a message ID in an invalid format.
  • Message Not Found Error – A message does not exist that corresponds to the supplied message ID.
  • Mailbox Repository Error – A generic error associated with the mailbox repository occurred.
  • Mailbox Service Error – A generic error associated with the mailbox service occurred.
Restrictions The only restriction is that the supplied message ID and document ID must both be valid (they must correspond to an actual message and an actual document in Sterling B2B Integrator).
Testing considerations Troubleshooting information for this service can be found in Sterling B2B Integrator Mailbox log files.

How the Mailbox Correlate Document Service Works

Sterling B2B Integrator Mailbox uses the Mailbox Correlate Document service to correlate the specified document to three separate components of the message: message name, message ID, and mailbox path.