Sterling File Gateway - Route Event service

The File Gateway Route Event service enables users to fire custom events as part of a route in Sterling File Gateway. The events will be viewable and searchable in the same manner as the pre-existing events.

The following table provides an overview of the File Gateway Route Event service:
System NameFile Gateway Route Event Service
Graphical Process Modeler (GPM) categoryAll Services
DescriptionThis service allows users to fire their own custom events as part of a route in Sterling File Gateway.
Business usageUse this service to fire events as part of a route in Sterling File Gateway.
Usage exampleIn a custom protocol business process, the user wants to record an event that shows the connection parameters for this protocol. The user would create the event in the customer_overrides.properties file, then edit the custom protocol business process to put the File Gateway Route Event Service in it to pass the parameters for the event.
Preconfigured?Yes
Requires third party files?No
Platform availabilityAll platforms supported by the application
Related servicesNone
Application requirementsNone
Initiates business processes?No
InvocationThis service must be invoked from a business process. The business process must have been started by Sterling File Gateway through its extension capability for consumer identification or custom protocol.
Business process context considerationsThe RouteEntityType, RouteEntityKey, RouteMetaData, and RouteDataflowId parameters must be passed into the File Gateway Route Event Service through an assign of either all elements or the custom elements individually.
Returned status values

0 = Success

1 = Failure

RestrictionsNone
Persistence levelSystem default
Testing considerationsNone

Implementing the File Gateway Route Event service

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

Configuring the File Gateway Route Event service

There are no configuration parameters for the File Gateway Route Event Service.

Parameters passed from business process to service

Field
Description
RouteEntityTypeUsed by Sterling File Gateway to associate the event with the correct Sterling File Gateway Route Entity. The value for this is passed into the business process from Sterling File Gateway and thus only needs to be passed through into the service and should not be changed. Required.
Possible values are:
  • ArrivedFileKey
  • RouteKey
  • DeliveryKey
RouteEntityKeyUsed by Sterling File Gateway to associate the event with the correct Sterling File Gateway Route Entity. The value for this is passed into the business process from Sterling File Gateway and thus only needs to be passed through into the service and should not be changed. Required.
RouteMetaDataContains data required by the event subsystem. The value for this is passed into the business process from Sterling File Gateway and thus only needs to be passed through and should not be changed. Required.
RouteDataflowIdContains the dataflow ID for the arrived file for this route. The value for this is passed into the business process from Sterling File Gateway and thus only needs to be passed through and should not be changed. Required.
EventCode

The code for the event. The code must be defined in the filegateway_eventcodes.properties file (when firing a system event) or the custom customer_overrides.properties file (when firing a custom event). Required.

ExceptionLevelThe exception level of the event. Used by the event framework in the platform. Optional. Possible values are:
  • Normal
  • Abnormal
  • Exceptional

The default value is exceptional.

EventAttributesContains a set of subelements that contain all the unique attributes for this event. Optional for events that have no attributes. Required for events that do have attributes.
<AttributeName>The actual attribute name is the name of the element, with content equal to the value of the attribute that you want to pass into the event. Optional.

Parameters passed from service to business process

There are no parameters passed from this service to a business process.

Previous Topic

Sterling File Gateway - Arrived File service

Parent Topic

Sterling File Gateway services

Next Topic

Sterling File Gateway - Listening Producer Service