Mailbox Scheduled Delete Service
The Mailbox Scheduled Delete service creates a schedule to delete mailbox messages that meet specific criteria.
The following table provides an overview of the Mailbox Scheduled Delete service:
|System name||Mailbox Scheduled Delete Service|
|Graphical Process Modeler (GPM) category||None|
|Description||Schedules message deletion in one or many mailboxes.|
|Business usage||Use this service to create a schedule to delete mailbox messages that meet specific criteria.|
|Usage example||The Sterling B2B Integrator Mailbox system administrator schedules the deletion of messages older than 30 days on Sundays at 2:00 AM.|
|Requires third-party files?||No|
|Platform availability||All supported Sterling B2B Integrator platforms|
|Application requirements||Nothing external to Sterling B2B Integrator is required to use this service.|
|Initiates business processes?||No|
|Invocation||The business process by using this service must be run by a user with permission to use any and all mailboxes that the delete request will attempt to delete. The exception to this rule is if the user has the Mailbox Global Delete permission. With the Mailbox Global Delete permission, this service will enable message deletion across all mailboxes.|
|Business process context considerations||The service extracts the user permissions at run time to confirm authorization of the business process to access the referenced mailboxes.|
|Returned status values||Returned status values:
|Restrictions||The limitations of this service are based on the assignment of mailbox permissions to users and groups. This service also can be used by users assigned the Mailbox Global Delete permission.|
|Testing considerations||Troubleshooting information for this service can be found in Sterling B2B Integrator Mailbox log files.|
How the Mailbox Scheduled Delete Service Works
Use the Mailbox Scheduled Delete service to delete messages from one or more mailboxes. As with all Sterling B2B Integrator scheduled services, you can configure the scheduled delete service to execute once at a specified date and time, or periodically such as once a month or twice a week.
Implementing the Mailbox Scheduled Delete Service
- Create a Mailbox Scheduled Delete service configuration. For information, see Managing Services and Adapters.
- Configure the Mailbox Scheduled Delete service. For information, see Configuring the Mailbox Scheduled Delete Service.
- Use the Mailbox Scheduled Delete service in a business process.
Configuring the Mailbox Scheduled Delete Service
To configure the Mailbox Scheduled Delete service, you must specify settings for the following fields in the Sterling B2B Integrator Admin Console or GPM:
|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:
|Delete only messages older than (days)||The number of days a message can exist in Sterling B2B Integrator Mailbox before being deleted. You can use any number greater than zero. Required.|
|Message Extractability||Delete only unextractable messages – Only messages
that are no longer extractable will be deleted. This includes with
the following extract policy values:
|Message Name Pattern||Pattern to select messages with names matching the pattern. The following characters cannot be used in a message name \ / : ? “ < > |.|
|Select Mailboxes for Message Removal||Mailbox paths to be queried during message deletion.
Required. Valid values are:
Note: Leaving this field blank (by not selecting All or Selected Mailboxes) will cause errors to be written to the status report.
|Run as User||Applies to the scheduling of the business process.
The Run As User field only displays as an option if Does
this service start a business process? is set to Yes.
Type the user ID to associate with the schedule, or click the icon and
select a user ID from the list. Valid value is any valid Sterling B2B Integrator user ID.
Note: This parameter allows someone who does not have rights to a specific business process to run it. If you select Admin as the user ID, you will inherit Administrative rights (for this run of the business process only), and enable the scheduled run.
|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 business process
invoked by this service. Valid values:
Note: The field names in parentheses represent the corresponding field names in the GPM. This information is provided for your reference.
Output from Service to Business Process
The following table contains the parameter passed from the Mailbox Scheduled Delete service to a business process:
|MessageId||ID of the stored message.|