Format of the request and response without adapter action

You can use this option to execute a specified SQL query against the Tivoli Netcool/OMNIbus database. The following table describes the request elements for the actor adapter without adapter action.

Elements for actor adapter request without adapter action

Element

Description

Required

<action>

Specifies the SQL statement to be issued to the Tivoli Netcool/OMNIbus database (standard SQL statement)

Yes

The following figure shows a template for an actor adapter request without adapter action.

XML template for an actor adapter request without adapter action


<OMNIbusAdapterRequest>
  <action></action>
</OMNIbusAdapterRequest>

The following figure shows a sample actor adapter request without adapter action. Use the adapter request XML when you create a custom process by using the Call Adapter activity in TrueSight Orchestration Development Studio.

XML sample of an actor adapter request without adapter action


<OMNIbusAdapterRequest>
  <action>select * from foo</action>
</OMNIbusAdapterRequest>


The Tivoli Netcool/OMNIbus actor adapter returns an adapter response that contains the results from the SQL query defined in the adapter request.

The following table describes the elements of the Tivoli Netcool/OMNIbus actor adapter response to a request without adapter action.

Elements of the Tivoli Netcool/OMNIbus actor adapter response to a request without adapter action

Element

Description

<row>

Contains the columns and values returned by the query

<column>

Contains the value for a single column.

The Netcool/OMNibus column name is indicated in the 'name' attribute

<metadata>

Contains the response level summary information from an SQL query

<queryExecuted>

Contains the syntax of the SQL query statement defined in the OMNIbus Adapter request

<execution-milliseconds>

Specifies the duration of the command execution in milliseconds

<responseRowCount>

Specifies the number of rows returned in the response

<responseColumnCount>

Specifies the number of columns returned for each row

<status>

Indicates the status of the command execution

Valid values: success, error

<error>

Contains the error message in the event of a command level error

When the <status> value is success, the <error> element will not be present.

The following figure illustrates an XML template for an actor adapter response to a request without adapter action.

XML template for an actor adapter response to a request without action


<omnibus-response>
 <row>
  <column name="Serial">numeric value</column>
 </row>
 <metadata>
 <queryExecuted>select * from foo</queryExecuted>
 <execution-milliseconds>numeric value</execution-milliseconds>
 <responseRowCount>1</responseRowCount>
 <responseColumnCount>1</responseColumnCount>
  <status>sucess</status>
 <error>present only with status of 'error'</error>
 </metadata>
</omnibus-response>
Was this page helpful? Yes No Submitting... Thank you

Comments