$('a[name]').remove(); $('#ic-homepage__footer').before('

'); $("#tabs").tabs({ selected: 1 }); $("#ic-homepage__ic-tips").append( quickTipHTML() ); unhideOneProductTip(); $("#ic-homepage__product-tips").wrapInner('

'); $("#ic-homepage__feed-tips").wrapInner('

'); });

IBM Tivoli Monitoring > Version 6.3 > User's Guides > Agent Builder User's Guide IBM Tivoli Monitoring, Version 6.3

Monitor data from a SOAP data source.

Configure your agent to receive data from a SOAP data source.


By using the SOAP data source, you can specify an HTTP URL and send a GET, POST, or PUT request. For POST or PUT requests, you can specify the associated POST data. An XML response is retrieved and parsed, and the data is exposed to Tivoli Monitoring in attributes. You can define the attributes as all of the values within a particular element. Or you can define custom XPaths to specify how to populate individual attributes. You can also combine the two mechanisms.

Use the following procedure to collect XML responses from a URL:


Procedure

  1. On the Agent Initial Data Source page (Figure 1) or the Data Source Location page, click Data from a server in the Monitoring Data Categories area.

    Figure 1. Adding HTTP data

  2. In the Data Sources area, click SOAP.

  3. Click Next.

  4. On the SOAP Information page (Figure 2), enter a URL. The default value is: 

      http://${KQZ_HTTP_SERVER_NAME}:${KQZ_HTTP_PORT_NUMBER}

    You can use a configuration variable or multiple configuration variables that resolve to a URL. Click Insert Configuration Property to select a property to insert. See ( Customize agent configuration).

    Figure 2. SOAP Information page

  5. Select a request type. The default request type is Get. For Post and Put requests, enter the data to be processed.

    For Post and Put requests, the Insert Configuration Property is enabled. Click Insert Configuration Property to include a configuration variable in the data to be processed. See ( Customize agent configuration).

  6. Click Browse

    If after you enter a URL and select a request type, you do not want to use the SOAP browser to build the definition, enter a Row Selection XPath. You enter the Row Selection XPath in the SOAP Information window. Next, define all of the attributes for the attribute group.

  7. In the SOAP Browser window, do the following steps:

    1. Enter a URL and select a request type if you did not already do so.

    2. Click Configuration to set any configuration properties that are referenced in the URL or other fields.

    3. Click Connect to obtain data from the SOAP provider.

      When you connect to the URL, a list of XML elements for this URL is shown in a Document Object Model (DOM) tree. In the WebSphere Application Server example in (Figure 3), the following URL was entered: 

        http://nc053011.tivlab.raleigh.ibm.com:9080/wasPerfTool/servlet
/perfservlet?module= \threadPoolModule

      The PerformanceMonitor XML element is shown. This element is the top-level XML element in the XML document that is returned by the SOAP provider.

      Figure 3. SOAP Browser window

    4. In the DOM tree, find and select the XML node that you want to set as the Row Selection XPath. In the WebSphere Application Server example in (Figure 4), the PerformanceMonitor/Node/Server/Stat/Stat/Stat node is selected. This node represents a row of data in the attribute group. When you select a node in the DOM tree and click Add, you get all of the attributes and elements defined on that node of the tree. (You click Add in the IBM Tivoli Monitoring Attributes area).

      When a node is selected, the XML Attributes area shows any XML attributes defined for the selected node. Select an XML attribute and click Add to include this attribute in the list of IBM Tivoli Monitoring Attributes.

      If more than one row of data is expected, the XPath must map to a node set. Where the Row Selection XPath returns a node that is set with only one item, the attribute group contains only one row.

      Figure 4. SOAP Browser window

    5. Click Add in the IBM Tivoli Monitoring Attributes area. The list of Tivoli Monitoring attributes are shown and the Row Selection XPath field is filled.

      The XPath for each Tivoli Monitoring attribute is used to map XML nodes or elements to Tivoli Monitoring attributes. In the WebSphere Application Server example in theFigure 5, the first attribute in the list of Tivoli Monitoring attributes, Stat, is not of use and would be removed.

      You can edit the name and XPath for a Tivoli Monitoring attribute in the Type Value field. For more information about using XPaths, see XPath options

      Figure 5. SOAP Browser window

    6. In the SOAP Browser window, click OK to save your changes and return to the SOAP Information window.

  8. In the SOAP Information window, click Next.

  9. If you did not use Browse earlier and you entered the URL and Row Selection XPath in the SOAP Information window, the Attribute Information page is shown. Specify the information for the first attribute on the Attribute Information page, and click Finish. You can then specify more attributes using the Agent Editor. For more information about creating attributes, see (Create attributes).

  10. If you used the Browse function in step (6), the Select key attributes page is shown. On the Select key attributes page, select key attributes or indicate that this data source produces only one data row. See (Selecting key attributes).

  11. Optional: You can test this attribute group by clicking Test. For more information about testing, see Test SOAP attribute groups

  12. Optional: You can create a filter to limit the data that is returned by this attribute group by clicking Advanced. For more information about filtering data from an attribute group, see Filtering attribute groups

  13. Do one of the following steps:

    1. If you are using the New Agent wizard, click Next.

    2. Click Finish to save the data source and open the Agent Editor.


+

Search Tips   |   Advanced Search