Sterling File Gateway - Route service

The File Gateway Route service processes and transforms files in order to prepare them for delivery to a consumer partner.

The following table provides an overview of the File Gateway Route service:
System NameFile Gateway Route Service
Graphical Process Modeler (GPM) categoryNot applicable
DescriptionThis service processes and transforms files in order to prepare them for delivery to a consumer partner.
Business usageThis is a system service. It is used to transform a file that has arrived into the File Gateway system
Usage exampleThe system uses this service.
Preconfigured?Yes
Requires third party files?None
Platform availabilityAll platforms supported by the application
Related servicesNone
Application requirementsNone
Initiates business processes?Yes. This service may start sub-business processes for custom consumer identification and/or transformation.
InvocationYes. This service is invoked automatically in Sterling File Gateway processes and should not be modified.
Business process context considerationsNone
Returned status values

0 = Success

1 = Failure

RestrictionsThis service is only called by Sterling File Gateway and cannot be customized.
Persistence levelSystem default
Testing considerationsNone

Implementing the File Gateway Route service

This is a system service. You do not need to implement this service.

Configuring the File Gateway Route service

There are no configuration parameters for the File Gateway Route Service.

Parameters passed from business process to service

Field
Description
ArrivedFileKeyThe key that represents the arrived file created by the Arrived File Service. Required.

Parameters passed from service to business process

Field
Description
RouteDeliveriesA list of all the deliveries that the router will attempt to send to the File Gateway Delivery Service. Optional, used only when there are deliveries to make.
DeliveryContains all the elements required by the File Gateway Delivery Service required to make a delivery. Optional, used only when there are deliveries to make.
DeliveryKeyThe key that represents the Delivery. Required, one for each delivery.
DeliveryChannelKeyThe key that represents the Delivery Channel that the FileGatewayDeliveryService will use to make the delivery. Required, one for each Delivery.
ConsumerFileContains all the elements that represent the file to be delivered. Required, one for each delivery.
DocumentIdThe identifier of the document to be delivered. Required, one for each consumer file.
ContentTypeThe content type of the file to be delivered. Required, one for each consumer file.
FileNameThe file name of the file to be delivered. Required, one for each consumer file.
TypeThe type of the layer that is being delivered. Required, one for each consumer file.
MailboxPathThe mailbox path to deliver to. Required, one for each consumer file.
CreateMailboxIfMissingWhether or not to create the mailbox if it is missing in the delivery. Required attribute on MailboxPath. Valid values are:
  • Y – Create a mailbox if one matching the specified pattern does not already exist
  • N – Do not create a mailbox

Previous Topic

Sterling File Gateway - Create Partner Mailbox service

Parent Topic

Sterling File Gateway services