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.
| System Name | File Gateway Route Event Service |
| Graphical Process Modeler (GPM) category | All Services |
| Description | This service allows users to fire their own custom events as part of a route in Sterling File Gateway. |
| Business usage | Use this service to fire events as part of a route in Sterling File Gateway. |
| Usage example | In 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 availability | All platforms supported by the application |
| Related services | None |
| Application requirements | None |
| Initiates business processes? | No |
| Invocation | This 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 considerations | The 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 |
| Restrictions | None |
| Persistence level | System default |
| Testing considerations | None |
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 |
|---|---|
| RouteEntityType | Used 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:
|
| RouteEntityKey | Used 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. |
| RouteMetaData | Contains 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. |
| RouteDataflowId | Contains 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. |
| ExceptionLevel | The exception level of the event. Used by the event framework in the platform. Optional. Possible values are:
The default value is exceptional. |
| EventAttributes | Contains 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.
Sterling File Gateway - Arrived File service
Sterling File Gateway services
Sterling File Gateway - Listening Producer Service
Browse Categories
Share Blog Post
In today’s fast-paced world of data analytics and AI, optimizing your data infrastructure is key to unlocking valuable insights and driving innovation.
In today’s fast-paced world of data analytics and AI, optimizing your data infrastructure is key to unlocking valuable insights and driving innovation.
In today’s fast-paced world of data analytics and AI, optimizing your data infrastructure is key to unlocking valuable insights and driving innovation.
At Pragma Edge, we are a forward-thinking technology services provider dedicated to driving innovation and transformation across industries.
Thank you for submitting your details.
For more information, Download the PDF.
Thank you for the Registration Request, Our team will confirm your request shortly.
Invite and share the event with your colleaguesÂ
IBM Partner Engagement Manager Standard is the right solution
addressing the following business challenges
IBM Partner Engagement Manager Standard is the right solution
addressing the following business challenges
IBM Partner Engagement Manager Standard is the right solution
addressing the following business challenges
