Available TIBCO Hawk Methods

The following lists the methods available in the custom microagent and the method in the SDK microagent of TIBCO ActiveMatrix Adapter for Database (TIBCO Business Studio).

Although the microagents, methods, and arguments dialog in TIBCO Hawk Display lists more methods than are documented here, only the following methods are supported for the adapter.

For the methods available in the standard and class microagents, see "Appendix C TIBCO Adapter SDK Hawk Microagents and Methods" in TIBCO Adapter SDK Programmer’s Guide.

The following table lists the custom microagent methods:

Custom Method Description
getEventQueueSize() Retrieves the size of the TIBCO Rendezvous event queue for the specified adapter configuration.
setDebugLevel() Sets the debug level for the current adapter configuration.
toggleVerboseFlag() Changes the value of the verbose flag from on to off, or the reverse.
showConfiguration() Shows the configuration defined for the current agent.
terminateADBagent() Stops the current adapter agent.
getPollingInterval() Returns the current polling interval setting.
setPollingInterval() Sets the polling interval for Publication Service.
getPollingBatchSize() Gets the polling batch size for Publication Service.
setPollingBatchSize() Sets the polling batch size for Publication Service.

If you set the adb.perfMon property to on, the methods listed in the following table are displayed and available to use. If you set the adb.perfMon property to off, the methods are not displayed or useable.

The following table lists the custom microagent methods with the adb.perfMon property:

Custom Method Description
getActivityStatistics() Returns the total number of objects processed for all the schemas, based on the request type. Also, returns the number of success and error objects.
getActivityStatisticsByService Returns the total number of objects processed for each of the schemas associated with the specified service.
getActivityStatisticsByOperation() Returns the total number of objects processed for all the schemas by each service that is associated with a specified operation.
getThreadStatistics() Returns the operation counts of the current threads.
getQueueStatistics() Returns the current count of elements in any internal queue used by the adapter.
getConnectionStatistics() Returns the state and statistics for all the current connections used by the adapter.
resetActivityStatistics() Resets all the counts for the activity statistics.
resetThreadStatistics() Resets all the counts for the thread statistics.
resetConnectionStatistics() Resets all the counts for the queue statistics.

The following table lists the SDK microagent method:

Method Description
getStatus() Retrieves basic status information about the adapter.
The getStatus method is provided by TIBCO Adapter SDK. Note the following information returned by this method:
  • Instance ID: instance ID for this adapter configuration
  • Adapter Name: name of the application
  • Messages Received: number of TIBCO Rendezvous messages received
  • Messages Sent: number of TIBCO Rendezvous messages published

For more information about the getStatus method, see TIBCO Adapter SDK Programmer’s Guide.

Note: Information retrieved by the getStatus method does not indicate the records processed by the adapter services. The retrieved information contains not only records of the adapter services, but also records sent and received by the adapter itself for certain functions.
  • getEventQueueSize()
    (Custom) Retrieves the size of the TIBCO Rendezvous event queue for the specified adapter configuration.
  • setDebugLevel()
    (Custom) Sets the debug level for the current adapter configuration.
  • toggleVerboseFlag()
    (Custom) Changes the value of the verbose flag from on to off, or the reverse.
  • showConfiguration()
    (Custom) Shows the configuration defined for the current agent.
  • terminateADBagent()
    (Custom) Stops the current adapter agent.
  • getPollingInterval()
    (Custom) Returns the current polling interval setting.
  • setPollingInterval()
    (Custom) Sets the polling interval for Publication Service.
  • getPollingBatchSize()
    (Custom) Gets the polling batch size for Publication Service.
  • setPollingBatchSize()
    (Custom) Sets the polling batch size for Publication Service.
  • getActivityStatistics()
    (Custom with adb.perfMon) Returns the total number of objects processed for all the schemas, based on the request type. Also, returns the number of success and error objects.
  • getActivityStatisticsByService
    (Custom with adb.perfMon) Returns the total number of objects processed for each of the schemas associated with the specified service. Also, returns the number of success and error objects.
  • getActivityStatisticsByOperation()
    (Custom with adb.perfMon) Returns the total number of objects processed for all the schemas by each service that is associated with a specified operation. Also, returns the number of success and error objects.
  • getThreadStatistics()
    (Custom with adb.perfMon) Returns the operation counts of the current threads.
  • getQueueStatistics()
    (Custom with adb.perfMon) Returns the current count of elements in any internal queue used by the adapter. This includes the TIBCO Rendezvous event queues automatically spawned by TIBCO Rendezvous for each adapter.
  • getConnectionStatistics()
    (Custom with adb.perfMon) Returns the state and statistics for all the current connections used by the adapter.
  • resetActivityStatistics()
    (Custom with adb.perfMon) Resets all the counts for the activity statistics.
  • resetThreadStatistics()
    (Custom with adb.perfMon) Resets all the counts for the thread statistics.
  • resetConnectionStatistics()
    (Custom with adb.perfMon) Resets all the counts for the connection statistics.