Mailbox Extract Begin Service
The Mailbox Extract Begin service begins the extraction of a message from a mailbox. Call this service in a business process to automate the extraction of messages from designated mailboxes.
The following table provides an overview of the Mailbox Extract Begin service:
Category | Description |
---|---|
System name |
Mailbox Extract Begin Service |
Graphical Process Modeler (GPM) categories |
All Services, Internet B2B > Mailbox |
Description |
Begins the extraction of a message from a mailbox. |
Business usage |
Use this service to begin extracting a message from a mailbox. |
Usage example |
Extract all purchase orders from a mailbox and deliver them to the SAP adapter for back-office processing. |
Preconfigured? |
Yes |
Requires third party files? |
No |
Platform availability |
All supported application platforms |
Related services |
The Mailbox Extract Begin service works with the other Sterling B2B Integrator Mailbox services to provide
mailboxing capability:
|
Application requirements |
Nothing external to Sterling B2B Integrator is required to use this service. |
Initiates business processes? |
No |
Invocation |
User with appropriate permissions to access the target mailbox must run the business process. |
Business process context considerations |
The user permissions are extracted from the business process context at run time to confirm authorization of the business process to add messages to the target mailbox. |
Returned status values |
The possible status values a service can return are:
|
Restrictions |
The limitations of this service are based on the assignment of mailbox permissions to users and groups. |
Testing considerations |
Troubleshooting information for this service can be found in Sterling B2B Integrator Mailbox log files. |
How the Mailbox Extract Begin Service Works
Use the Mailbox Extract Begin service to extract messages from a mailbox. This service checks the extractability and availability of a message and verify whether the user that is running the business process has permissions on the mailbox.
If the extractability is ExtractableCount = 1, the Mailbox Extract Begin service locks the message until the extraction is complete. After the extraction is complete, the count is decremented. If the ExtractableCount = x, x number of Mailbox Extract Begin services can lock the message.
- Mailbox Extract Begin with CommitNow = No. This is the default mode. In this mode, you must include the Mailbox Extract Abort service and Mailbox Extract Commit service in your business process. This mode is useful to control the extract count. If an error occurs during the extraction, such as a protocol failure, the message count is set to the original count. The business process locks the message until the Mailbox Extract Commit service or the Mailbox Extract Abort service completes.
- Mailbox Extract Begin with CommitNow = Yes. In this mode, all message extracts are extracted and committed in a single step. This mode is useful if you do not need control over the extract count. If an error occurs during the extract, such as a protocol failure, the message count will not be incremented back to the original count. The business process does not lock the message.
Business Process Example
The following BPML extracts the message 1234 from a Sterling B2B Integrator mailbox. This business process succeeds if the user associated with this BPML has permission to the mailbox contains message 1234.
<!-- Read in the payload. -->
<operation name="Mailbox ExtractBegin Service">
<participant name="MailboxExtractBegin"/>
<output message="ExtractBeginRequest">
<assign to="." from="*"></assign>
<assign to="MessageID">1234</assign>
</output>
<input message="inmsg">
<assign to="." from="*"></assign>
</input>
</operation>
Implementing the Mailbox Extract Begin Service
- Create a Mailbox Extract Begin service configuration. For information, see Managing Services and Adapters.
- Configure the Mailbox Extract Begin service. For information, see Configuring the Mailbox Extract Begin Service.
- Use the Mailbox Extract Begin service in a business process.
Configuring the Mailbox Extract Begin Service
The following table describes the fields used to configure the Mailbox Extract Begin service in the GPM:
Field | Description |
---|---|
Config |
Name of the adapter configuration. |
CommitNow |
Valid values are:
|
MessageID |
ID of the stored message. Required. Valid values are numbers >=0 in traditional mailboxes and in UUID format in Global Mailbox. |
UseGlobalMailboxes |
Whether to use only Global Mailbox or only traditional Sterling B2B Integrator mailboxes. The following values are valid:
|
Input to Service from Business Process
The following table contains the parameters passed into the Mailbox Extract Begin service from a business process:
Parameter | Description |
---|---|
ViewOnly | Valid values are:
|
Output from Service to Business Process
The following table contains the parameters passed from the Mailbox Extract Begin service to a business process:
Parameter | Description |
---|---|
MessageID |
ID of the stored message. |
DocumentId |
Document ID corresponding to the stored message. |
CreateDateTime |
Creation date. |
MessageName |
Name of the message. |
MailboxPath |
Path of the mailbox which the message was added to. If the user has been set up with a virtual root, the MailboxPath will be a relative path to the virtual root. The virtual root is not visible to the business process. |
ContentType |
Indicates the MIME type and subtype. Use the following format: MIME Type/MIME Subtype . |
MessageSize |
Size of the added message in bytes. |
ExtractableCount |
Number of times this message may be accessed. One of the three extractability parameters is returned. |
Extractable |
Indicates whether this message can be extracted. One of the three extractability parameters is returned. |
ExtractableUntil |
The last date and time that this message may be extracted. One of the three extractability parameters is returned. |