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

Pragma Edge, IBM Gold Partner, IBM, Pragmaedge,

Train, validate, tune and deploy AI models with watsonx.ai

BPML, an XML-based language, serves to depict and execute business processes. Each business process is outlined in a distinct BPML document termed as a business process model (.bpml or .bp file). These models represent the blueprint of how processes operate within Sterling B2B Integrator.

Read More »
Pragma Edge, IBM Gold Partner, IBM, Pragmaedge,

Sterling B2B Integrator and BPML

BPML, an XML-based language, serves to depict and execute business processes. Each business process is outlined in a distinct BPML document termed as a business process model (.bpml or .bp file). These models represent the blueprint of how processes operate within Sterling B2B Integrator.

Read More »
Pragma Edge, IBM Gold Partner, IBM, Pragmaedge,

Foundation models in watsonx.ai 

BPML, an XML-based language, serves to depict and execute business processes. Each business process is outlined in a distinct BPML document termed as a business process model (.bpml or .bp file). These models represent the blueprint of how processes operate within Sterling B2B Integrator.

Read More »

Thank you for the Registration Request, Our team will confirm your request shortly.

Invite and share the event with your colleagues 

FileGPS - End To End File Monitoring

Subscribe to our newsletter

Elevate your approach to technology with expert-authored blogs, articles, and industry perspectives.

Thank You!

Thanks for signing up! We look forward to sharing resources and updates with you.

Continue to view our resources below.

Thank You!

Your Article submission request has been successfully sent. We will review your article & contact you very soon!

Sign up for Free Trail

Community manager solution extends IBM Sterling B2B Integrator to deliver next-generation B2B and File Transfer capabilities that meet the growing demands of the customer.

Thank You!

Thanks for contacting us. We will reach you shortly!

Select Industry & Watch IBM Partner Engagement Manager Demo

Start SRE Journey to AIOPs

FileGPS - End To End File Monitoring

Pragma Edge Jarvis Monitoring tool (Jarvis)

Thank you for submitting your details.

For more information, Download the PDF.

Community Manager - PCM

Community Manager - PCM

To deliver next-generation B2B and File Transfer capabilities

Pragma Edge - API Connect

IBM Partner Engagement Manager Standard

IBM Partner Engagement Manager Standard is the right solution
addressing the following business challenges

IBM Partner Engagement Manager Standard

IBM Partner Engagement Manager Standard is the right solution
addressing the following business challenges

IBM Partner Engagement Manager Standard

IBM Partner Engagement Manager Standard is the right solution
addressing the following business challenges

Thank you for the Registration Request, Our team will confirm your request shortly.

Invite and share the event with your colleagues 

Please Join us
On April 21 2021, 11 AM CT