Sterling File Gateway - Arrived File service

The File Gateway Arrived File service verifies and processes files that arrive into Sterling File Gateway. It also determines if the files need to be routed and/or deleted.

The following table provides an overview of the File Gateway Arrived File service:
System NameFile Gateway Arrived File Service
Graphical Process Modeler (GPM) categoryNot applicable
DescriptionThis service verifies and processes files that arrive into Sterling File Gateway. It also determines if the files need to be routed and/or deleted.
Business usageThis is a system service. It is used to verify and process 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.
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 Arrived File service

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

Configuring the File Gateway Arrived File service

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

Parameters passed from business process to service

Field
Description
ReplayArrivedFileKeyThe key that represents the original arrived file if this is a replay. Optional.
ReplayCommentThe comment entered by the user on the replay. Optional.
MessageIdThe message identifier that this service will route through Sterling File Gateway. Required.

Parameters passed from service to business process

Field
Description
ArrivedFileKeyThe key that represents the Arrived File.
ShouldDeleteMessageWhether or not the message should be deleted by the workflow.
ShouldRouteMessageWhether or not the arrived file should be routed by the workflow.

Previous Topic

Sterling File Gateway Delivery service

Parent Topic

Sterling File Gateway services

Next Topic

Sterling File Gateway - Route Event service