Mailbox Update Service

The Mailbox Update service is used in a business process to update a message in a mailbox.

The following table provides an overview of the Mailbox Update service:

Category	Description
System name	Mailbox Update Service
Graphical Process Modeler (GPM) category	None
Description	Updates messages in a mailbox.
Business usage	A trading partner would use this service to update messages in Sterling B2B Integrator mailboxes or Global Mailbox.
Usage example	A business process updates the extractability of a message, or resubmits the message for routing.
Preconfigured?	Yes
Requires third-party files?	No
Platform availability	All supported application platforms
Related services	No
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	No
Returned status values	Returned status values: Success – Normal completion. User Permission Error – The user associated with the business process does not have permission to use the target mailbox. Invalid Mailbox Error – The mailbox identified as the query target does not exist. Mailbox Message Not Found Error – The message specified cannot be found. Mailbox Message Multiple Extractable Types Specified By Business Process Error – The data sent to the process contains specifications for more than one extractability type. Mandatory Parameter Missing Error – A necessary parameter (such as MessageId) is missing. 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 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 Update Service Works

The Mailbox Update service is used to update the status of a message.

Implementing the Mailbox Update Service

To implement the Mailbox Update service for use in a business process:

Create a Mailbox Update service configuration. For information, see Managing Services and Adapters.
Configure the Mailbox Update service. For information, see How the Mailbox Update Service Works.
Use the Mailbox Update service in a business process.

Configuring the Mailbox Update Service

To configure the Mailbox Update service, you must specify settings for the following fields in the GPM:

Field	Description
Extractable	Indicates whether this message can be extracted. Valid values are Yes and No. Note: You must provide a value for this field or one of the following: ExtractableCount ExtractableUntil
ExtractableCount	Number of times this message may be accessed. Optional. One of the three extractability parameters is returned. Valid values are >= 0. Note: You must provide a value for this field or one of the following: Extractable ExtractableUntil
ExtractableUntil	The last date and time that this message may be extracted. Valid values are dates and times in `yyyyMMddThhmm` format. Important: You must provide a value for this field or one of the following: Extractable ExtractableCount
MessageId	ID of the stored message. Required. Valid values are numbers >=0.
ResubmitMessage	Indicates if this message should be resubmitted for routing. Valid values are Yes and No. Tip: When this parameter is set to 'YES' for a message in a Global Mailbox, the event rule is triggered, but a new event is not shown in the Global Mailbox. Instead, for the same event, the Date Sent column is updated.
UseGlobalMailboxes	Whether to use only Global Mailbox or only traditional Sterling B2B Integrator mailboxes. The following values are valid: Yes - The Global Mailbox is used. The UseGlobalMailboxes parameter is displayed in the business process XML, with the value set to YES. No - The Global Mailbox is not used. The UseGlobalMailboxes parameter is displayed in the business process XML, with the value set to NO. If this flag is not specified, based on the MessageId format: SI format - Only traditional mailboxes are searched UUID format - Only Global Mailbox is searched If the parameter is set, that takes precedence over the MessageId format.

Business process for Global Mailbox

This is the BPML for the business process to update the status of Global Mailbox:

<process name="Mailbox_testUpdateMessage"> 
<sequence name="MailboxUpdate"> 
 <operation name="Mailbox Update Service"> 
  <participant name="MailboxUpdate"/> 
     <output message="ExtractCommitRequest"> 
     <assign to="UseGlobalMailboxes">yes</assign> 
     <assign to="MessageId">cba0cb60-6a53-11e4-8fbe-67e28453219b</assign> 
     <assign to="Extractable">yes</assign> 
     <assign to="." from="*"></assign> 
     </output> <input message="inmsg"> 
     <assign to="UpdateResults" from="*">  
     </assign> 
    </input> 
   </operation> 
  </sequence> 
</process>