OdetteFTP Scheduler Service

The OdetteFTP Scheduler service initiates OFTP sessions for sending mailbox messages based on a time schedule.

The following table provides an overview of the service:

Category Description
System name Service
Graphical Process Modeler (GPM) category All Services
Description The OdetteFTP Scheduler service is used to initiate OFTP sessions for sending mailbox messages based on a time schedule.
Business usage The scheduler starts a business process, configured in the Partner Profile Time Schedule, which calls the OdetteFTP adapter. The service initiates the OdetteFTP adapter (if the partner contract defines Mailbox Mode) based on a partner-specific schedule.
Usage example The OdetteFTP Scheduler service is used to initiate OFTP sessions for sending mailbox messages based on a time schedule. A time schedule and a business process name may be defined in the Partner Profile for each Physical Partner Contract. When the next scheduled point of time is reached following actions are performed depending on the action type of the scheduled entry:
  • Action Type = ConditionalCall: The looks up the mailbox related to the Physical Partner Contract and checks for files to send (Status = Scheduled or Retry). If yes, it initiates a business process and OFTP session.
  • Action Type = UnconditionalCall: The triggers a business process and passes the PhysicalPartnerContract name to it. The business process calls an OdetteFTP instance to look up the Mailbox related to the Physical Partner Contract. An OFTP session sends the mailbox messages to the Remote Physical Partner. Use this action type to poll a partner mailbox without sending messages to the partner.
Preconfigured? No
Requires third-party files? No
Platform availability All supported platforms for Sterling B2B Integrator
Related services OdetteFTP adapter (Mailbox mode only), OdetteFTP Queue Handler service
Application requirements The service is used with the OdetteFTP adapter in Mailbox mode.
Initiates business processes? Yes
Invocation No
Business process context considerations None
Returned status values None
Restrictions None
Persistence level System default
Testing considerations Not applicable

Implementing the Service

This service is not called by a business process. It is started automatically when the OdetteFTP Scheduler is started and shuts down when the OdetteFTP Scheduler is stopped. Enable and disable the service by starting and stopping the service in the Administration menu.

Configuring the Service

To configure the service, you must specify field settings in Sterling B2B Integrator or the GPM:

Field Description
CleanupInterval Length, in hours, how long records that did not reach a terminated status should remain in the process history. Valid value is any integer. Required.

Partner Mailboxes

To use OFTP with the mailbox system, you must have a standard sub-mailbox lay out for storing scheduled and received OFTP files in your Mailbox Virtual Root. Files to be sent are stored in the sub-mailbox named Inbox. Received files are stored in the Virtual Root of the Mailbox User.