BMC Mainview AutoOperator actor adapter request and response

You can use the information in this topic with the Call Adapter activity to create an adapter request. For detailed instructions about how to use the Call Adapter activity, see Call Adapter activity and Creating and configuring the Call Adapter activity.

You do not need to specify configuration parameters in the actor adapter requests unless you want to override the adapter configuration. 

The actor adapter can perform different API calls on the MV-AO cell. The adapter requests contain values that are used to execute API calls. The set of values used to make each API call is referred to as an operation.

Send Events operation

The Send Events operation enables you to send events on MV-AO cell based on the information specified in the request.

Each request to the adapter starts a sequence of requests and responses between the adapter and the MV-AO cell. When an adapter receives a request, the following sequence occurs:

1. The adapter looks up the IP address of the host cell in the mcell.dir file local to the BMC Atrium Orchestrator peer. For details about the mcell.dir file, see #Communicating with a MV-AO cell.
2.  The adapter opens a client connection to the cell specified in the request or the default cell specified in the adapter configuration.
3.  The adapter converts the requests into Basic Recorder of Objects in C (BAROC) formatted queries that a MV-AO cell understands.
4.  The adapter sends the actual event request to the server. The server returns the response of success of failure of message delivery.
5.  The adapter closes the client connection.
6.  Adapter sends the response back to caller.

The following figure shows a sample <items> XML for the Send Events operation

<items>
  <item>
    <slot-values>
       <slot name="severity">MAJOR</slot>
       <slot name="mc_priority">"PRIORITY_2"</slot>
       <slot name="msg">An example message</slot>
    </slot-values>
  </item>
</items>

The following table describes the input elements for the Send Event process.

Adapter request elements for the Send Events operation

The following figure shows a sample adapter request for the Send Event operation: 

Sample adapter request for the Send Event operation 

<mv-ao-request>
        <send-events>
              <send-event>
                  <cell-name>MVAOCell</cell-name>
                  <user-name>baouser</user-name>
                  <event-class-name>BAO_TEST</event-class-name>
                  <slot-values>
                      <slot name="severity">MAJOR</slot>
                      <slot name="mc_priority">"PRIORITY_2"</slot>
                      <slot name="msg">An example message</slot>
                  </slot-values>
              </send-event>
       </send-events>
</mv-ao-request>

Sample adapter response for the Send Event operation when the event request is successfully sent to MV-AO cell

<adapter-response>
  <execution-duration>1070</execution-duration>
  <status>success</status>
  <messageBase64></messageBase64>
  <data>
    <mv-ao-send-event-result>
      <metadata>
        <status>success</status>
      </metadata>
    </mv-ao-send-event-result>
  </data>
</adapter-response>

Sample adapter response for the Send Event operation when the event request fails to send to MV-AO cell

<adapter-response>
  <execution-duration>11627</execution-duration>
  <status>success</status>
  <messageBase64></messageBase64>
  <data>
    <mv-ao-send-event-result>
      <metadata>
        <status>error</status>
        <error-message>ConnectionException when sending event to EK5X: BMC-IMM011001E {EK5X}</error-message>
      </metadata>
    </mv-ao-send-event-result>
  </data>
</adapter-response>