File Gateway Delivery service
The File Gateway Delivery service delivers files that have been transformed to consumer partners.
The following table provides an overview of the File Gateway Delivery
service:
System Name | File Gateway Delivery Service |
Graphical Process Modeler (GPM) category | Not applicable |
Description | This service delivers files that have been transformed to consumer partners. |
Business usage | This is a system service. It is used to deliver a transformed file to a consuming partner. |
Usage example | The system uses this service. |
Preconfigured? | Yes |
Requires third party files? | No |
Platform availability | All platforms supported by the application |
Related services | File Gateway Arrived File Service |
Application requirements | None |
Initiates business processes? | Yes. This service may start a sub process for a protocol transfer to a listening consumer. |
Invocation | Yes. This service is invoked automatically in Sterling File Gateway processes and does not need to 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 Delivery service
This is a system service. You do not need to implement this service.
Configuring the File Gateway Delivery service
There are no configuration parameters for the File Gateway Delivery Service.
Parameters passed from business process to service
Field | Description |
---|---|
ConsumerMessageId | The message ID to send to the consumer. Required. |
Delivery | Contains all the elements required by the FileGatewayDeliveryService required to make a delivery. |
DeliveryKey | The key that represents the created Delivery Object. Required. |
ConsumerFile/DeliveryChannelKey | The key that represents the Delivery Channel that the File Gateway Delivery Service will use to make the delivery. Required. |
ConsumerFile | Contains all the elements that represent the file to be delivered. Required. |
ConsumerFile/ DocumentId | The identifier of the document to be delivered. Required. |
ConsumerFile/ ContentType | The content type of the file to be delivered. Required. |
ConsumerFile/ Size | The file name of the file to be delivered. Required. |
ConsumerFile/ FileName | The size of the file to be delivered. Required. |
ConsumerFile/ Type | The type of the layer that is being delivered. Required. |
ConsumerFile/ MailboxPath | The mailbox path to deliver to. Required. |
CreateMailboxIfMissing | Whether to create this mailbox if it does not already exist. Required. |
Parameters passed from service to business process
There are no parameters passed from this service to a business process.