Using SQL Adapters with Ensemble Using the SQL Outbound Adapter [Home] [Back] [Next]

• Default behavior
• How to create a business operation to use this adapter
• Details on how to create methods in that business operation
• How to handle multiple SQL statements per message
• How to add and configure the business operation

• Executing queries
• Executing stored procedures
• Performing inserts, updates, and deletes

• Your business operation class should extend Ens.BusinessOperation.
• The ADAPTER parameter should equal EnsLib.SQL.OutboundAdapter.
• The INVOCATION parameter should specify the invocation style you want to use, which must be one of the following.
  • Queue means the message is created within one background job and placed on a queue, at which time the original job is released. Later, when the message is processed, a different background job will be allocated for the task. This is the most common setting.
  • InProc means the message will be formulated, sent, and delivered in the same job in which it was created. The job will not be released to the sender’s pool until the message is delivered to the target. This is only suitable for special cases.
• Your class should define a message map that includes at least one entry. A message map is an XData block entry that has the following structure:

  XData MessageMap
  {
  <MapItems>
    <MapItem MessageType="messageclass">
      <Method>methodname</Method>
    </MapItem>
    ...
  </MapItems>
  }
  

• Your class should define all the methods named in the message map. These methods are known as message handlers. In general, these methods will refer to properties and methods of the Adapter property of your business operation.
• For other options and general information, see “Defining a Business Operation Class” in Developing Ensemble Productions.

Class ESQL.NewOperation1 Extends Ens.BusinessOperation 
{
Parameter ADAPTER = "EnsLib.SQL.OutboundAdapter";

Parameter INVOCATION = "Queue";

Method SampleCall(pRequest As Ens.Request, Output pResponse As Ens.Response) As %Status
{
  Quit $$$ERROR($$$NotImplemented)
}

XData MessageMap
{
<MapItems>
  <MapItem MessageType="Ens.Request">
    <Method>SampleCall</Method>
  </MapItem>
</MapItems>
}
}

 set tSC = ..Adapter.ExecuteUpdate(.numrows,sql)

/// Insert into NewCustomer table
Method Insert(pReq As ESQL.request, Output pResp As ESQL.response1) As %Status
{
 kill pResp
 set pResp=$$$NULLOREF

 set sql="insert into NewCustomer (Name,SSN,City,SourceID) values (?,?,?,?)"

 //perform the Insert
 set tSC = ..Adapter.ExecuteUpdate
   (.nrows,sql,pReq.Name,pReq.SSN,pReq.City,pReq.CustomerID)

 //create the response message
 set pResp=##class(ESQL.response1).%New()
 set pResp.AffectedRows=nrows

 if 'tSC write " failed ",tSC quit tSC
 quit 1
}

OnMessage(..)
{
    Set tStayConn=..Adapter.StayConnected
    Set ..Adapter.StayConnected=-1
 
    //... your ..Adapter SQL Operations here...
 
   Set ..Adapter.StayConnected=tStayConn
   If 'tStayConn&&..Adapter.Connected Do ..Adapter.Disconnect()
   Quit tSC
}

1. Add an instance of your custom business operation class to the Ensemble production.
2. Enable the business operation.
3. Configure the adapter to communicate with a specific external data source. Specifically:
   • Specify the data source to which the adapter should connect
   • Use other common runtime settings for your production
4. Run the production.