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 Name File Gateway Route Service
Graphical Process Modeler (GPM) category Not applicable
Description This service processes and transforms files in order to prepare them for delivery to a consumer partner.
Business usage This is a system service. It is used to transform a file that has arrived into the File Gateway system
Usage example The system uses this service.
Preconfigured? Yes
Requires third party files? None
Platform availability All platforms supported by the application
Related services None
Application requirements None
Initiates business processes? Yes. This service may start sub-business processes for custom consumer identification and/or transformation.
Invocation Yes. This service is invoked automatically in Sterling File Gateway processes and should not be modified.
Business process context considerations None
Returned status values

0 = Success

1 = Failure

Restrictions This service is only called by Sterling File Gateway and cannot be customized.
Persistence level System default
Testing considerations None

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
ArrivedFileKey The key that represents the arrived file created by the Arrived File Service. Required.

Parameters passed from service to business process

Field Description
RouteDeliveries A 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.
Delivery Contains all the elements required by the File Gateway Delivery Service required to make a delivery. Optional, used only when there are deliveries to make.
DeliveryKey The key that represents the Delivery. Required, one for each delivery.
DeliveryChannelKey The key that represents the Delivery Channel that the FileGatewayDeliveryService will use to make the delivery. Required, one for each Delivery.
ConsumerFile Contains all the elements that represent the file to be delivered. Required, one for each delivery.
DocumentId The identifier of the document to be delivered. Required, one for each consumer file.
ContentType The content type of the file to be delivered. Required, one for each consumer file.
FileName The file name of the file to be delivered. Required, one for each consumer file.
Type The type of the layer that is being delivered. Required, one for each consumer file.
MailboxPath The mailbox path to deliver to. Required, one for each consumer file.
CreateMailboxIfMissing Whether 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