fgEventCodes properties

fgEventCodes contains a complete list of known Sterling File Gateway event codes.

Update fgEventCodes when you want to:
  • Add new Sterling File Gateway codes, such as custom codes, to the Sterling File Gateway event code set that is known to IBM® Sterling Control Center Monitor.
  • Tell IBM Sterling Control Center Monitor whether a specific Sterling File Gateway event code represents an error.
  • Tell IBM Sterling Control Center Monitor whether a specific Sterling File Gateway event code is associated with a file transfer.

You can access fgEventCodes in the IBM Sterling Control Center Monitor web console by clicking your user ID and then clicking System configuration > Properties > fgEventCodes.

Table 1. fgEventCodes properties
Property name Property description Required? Property value
id The Sterling File Gateway event code. Yes  
eventType Specifies the event type for the IBM Sterling Control Center Monitor events that are created for Sterling File Gateway events with the Sterling File Gateway event code. For more information about event types, see Event type descriptions. Yes Valid values are integers in the range of 1 - 17.
error

If you set the value to TRUE, it means when IBM Sterling Control Center Monitor sees a Sterling File Gateway event with the specified Sterling File Gateway event code, an IBM Sterling Control Center Monitor event with a return code of 8 is generated, which represents an error.

Otherwise, you can omit the error subelement, or set the value to FALSE. In this case, an IBM Sterling Control Center Monitor event with a return code of 0 is generated.

No Valid values are TRUE | FALSE.
msgElements

Specifies the message elements of the Sterling File Gateway events to be included in the resulting IBM Sterling Control Center Monitor events.

Each msgElements subelement can have one or more subelements. The name of each subelement represents the IBM Sterling Control Center Monitor event element names to be added to the resulting IBM Sterling Control Center Monitor event. The value represents the Sterling File Gateway message value that is to be used as the IBM Sterling Control Center Monitor event element value.

No  
xfer

Specifies whether IBM Sterling Control Center Monitor events that are created for Sterling File Gateway events with the Sterling File Gateway event code are file transfer events.

If the xfer subelement is specified with a value of FALSE, or xfer is not specified, the IBM Sterling Control Center Monitor events that are created for the Sterling File Gateway events with the Sterling File Gateway event code are not file transfer events.

No Valid values are TRUE | FALSE.
Here is a sample fgEventCodes snippet:

<eventCode>
              <!-- Business Process Starting -->
              <id>FG_0201</id>
              <!-- Delivery Step Started --><eventType>1</eventType>
              <msgElements>
                 <destFile>DestinationMessageName</destFile>
              </msgElements>
</eventCode>
<eventCode>
              <!-- Arrived File Failed -->
              <id>FG_0455</id>
              <!-- Process End --><eventType>4</eventType>
              <error>TRUE</error>
              <xfer>TRUE</xfer>
              </eventCode>
      

In this example, when the IBM Sterling Control Center Monitor node service processes a Sterling File Gateway event with the FG_201 event code, the node service creates a corresponding IBM Sterling Control Center Monitor event with event type 1. The node service finds the value of DestinationMessageName in the message of the Sterling File Gateway event and includes the destFile element with a value of DestinationMessageName from the Sterling File Gateway event in the IBM Sterling Control Center Monitor event that is constructed. However, the IBM Sterling Control Center Monitor event that is generated is not a file transfer event because eventCode does not include an xfer subelement. The IBM Sterling Control Center Monitor event that is generated has a return code value of 0 because there is no error subelement.

When the node service processes a Sterling File Gateway event with the FG_0455 event code, the node service constructs an IBM Sterling Control Center Monitor event of event type 4. The IBM Sterling Control Center Monitor event has a return code value of 8 because the eventCode element includes an error subelement with a value of TRUE. And also, the IBM Sterling Control Center Monitor event is a file transfer event because that same eventCode contains an xfer subelement with a value of TRUE.