For Substation ES Recipe Service

This TIBCO ActiveMatrix BusinessWorks™ 6.x project uses the Mainframe TCP API to establish connection to the Substation ES TCP interface and to initiate the request message send to the Substation ES recipe service.

To use the recipe sample project, you must set the following process variables of the Rest-Recipe.bwp and ContactSubstationES-Recipe.bwp processes to match the corresponding Substation ES setup:
Process Variables Description
URL The URL of the TCP interface to which Substation ES listens to
UserID The z/OS user ID
Password The password corresponding to the z/OS user ID
Recipe-Service-Name The recipe service which Substation ES will use to process the requests
Retry The number of retries allowed to connect
Note: For the application to run correctly, ensure that S7R-TCP bundle is included in the configuration for ActiveMatrix BusinessWorks.

Process Flow for the TimerProcess Example

Upon starting the process, the Timer activity will be executed. It will call "ContactSubstationESRecipe.bwp" subprocess. Once this subprocess is initiated, the following events will take place:
  • Activity "SetupConnection" calls "setTCPGlobals" java method in "RecipeService" to set connection information
  • Activity "InterfaceWithSubstationES" calls "Converse" java method in "RecipeService" which sends on message to Substation ES TCP interface and waits for response
  • The response message data is returned from the subprocess

Process Flow for the Rest-Recipe Example

This process is initiated by a "REST" event. There are optional input parameters ("Data" and "CorrelationId") that you can define in the "REST-RECIPE.bwp" HTTP-Rest Get request before initiating the process. Once the process is initiated, the following events take place:
  • Activity "SetupConnection" calls "setTCPGlobals" java method in "RecipeService"to set connection information
  • Activity "InterfaceWithSubstationES" calls "Converse" java method in "RecipeService" which sends the message to Substation ES TCP interface and waits for response
  • The response message data is returned for a HTTP-Rest response