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 Name File Gateway Arrived File Service
Graphical Process Modeler (GPM) category Not applicable
Description This 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 usage This is a system service. It is used to verify and process 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.
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 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
ReplayArrivedFileKey The key that represents the original arrived file if this is a replay. Optional.
ReplayComment The comment entered by the user on the replay. Optional.
MessageId The message identifier that this service will route through Sterling File Gateway. Required.

Parameters passed from service to business process

Field Description
ArrivedFileKey The key that represents the Arrived File.
ShouldDeleteMessage Whether or not the message should be deleted by the workflow.
ShouldRouteMessage Whether or not the arrived file should be routed by the workflow.