Executing a Request from the ActiveMatrix Administrator UI

Service Health Check can now be invoked on SOAP and REST endpoints using Administrator UI. The Health Check response is displayed in graphical format in Administrator UI.

Prerequisites

  1. Prior to invoking Service Health Check, ensure that following resource templates are available in the resource template list in Shared Objects > Resource Templates. The following resource templates and the resource instances are created by default during configuration of the ActiveMatrix Administrator.
    • HTTP Client: TIBCO ActiveMatrix HealthCheck HTTP Client Resource
    • For SSL communications, SSL Client Provider: TIBCO ActiveMatrix HealthCheck SSL Client Provider Resource
      Note: SSL protocol used in TIBCO ActiveMatrix HealthCheck SSL Client Provider resource template is TLSv1, you can change it to TLSv1.2 which is the default for ActiveMatrix Administrator.
    • Keystore Provider: TIBCO ActiveMatrix HealthCheck Keystore Provider Resource
    • Keystore: healthcheckkeystore.jks

    For more information on resource templates, see Managing Resource Templates

  2. If application is deployed on remote machine ensure that hostname is known between Administrator and remote machines.
    Note: Prior to running Service Health Check from Administrator UI on a upgraded setup, you must create resource template, resource instance and install resource instance required for running Service Health Check from Administrator UI. Refer to "Post Upgrade Actions" section of Installation and Configuration Guide for these steps.

Procedure

  1. In TIBCO ActiveMatrix Administrator, click Infrastructure > Health Check. A list of all Applications in the Enterprise is displayed.
  2. From the list of Applications, select the Application for which you want to invoke Service Health Check. When the row is selected, Health Check invocation parameters and List of Bindings for the selected Application is displayed below the Applications table.
    Example: Application jv.helloworld1.soa_1 contains Bindings HelloWorld1SOAP,RESTService_Binding1.

  3. In the Health Check Parameters section, enter the parameters for the request:
    Parameter Optional Default Value Description
    No. of hops No -1 The hops element controls the span of the Service Health Check invocation, in terms of length (in the case of applications connected as a chain) or depth (in the case of applications connected in a tree/graph structure). For more information, see Request Parameters
    Timeout (milliseconds) Yes NA

    The Timeout element specifies a timeout value for the Service Health Check invocation in milliseconds. For more information, see Request Parameters

    Suppress Stack Trace Yes False

    The Suppress Stack Trace element specifies whether an exception stack trace in a Service Health Check response must be suppressed or not. For more information, see Request Parameters

  4. To cache the Service Health Check response and/or provide authentication details in case of Bindings where Authentication policy is configured, expand the Advanced section.
    1. (Optional) Enter the following caching-related parameters:
      Note: Refresh Cache, Validity Duration, and Refresh If Older Than parameters are valid only if Health Check caching is enabled. For the related procedures, see Enabling or Disabling the Caching of a Health Check Response.
      Parameter Default Value Description
      Refresh cache False

      The Refresh cache element controls whether the Service Health Check response for the current Service Health Check request must be cached or not. For more information, see Request Parameters

      Validity Duration In Secs NA

      This element specifies the validity of a particular Service Health Check response in seconds. After the Validity Duration In Secs elapses, the response is considered invalid and is removed from the cache. For more information, see Request Parameters

      Refresh If Older Than In Secs NA

      This parameter is used to make sure that the returned response is not older than the value specified in the Refresh If Older Than parameter. For more information, see Request Parameters

    2. If Authentication Policy has been configured for the selected Binding, enter the user name and password.
  5. In the List of Bindings for Application section:
    1. (Optional) To generate WSDL for SOAP binding or Swagger JSON for REST binding click the binding name.
    2. To invoke the Service Health Check request click Run button next to Binding.

    In the Health check Response UI section, the XML response is displayed in a graphical format. For more information about Response UI see Response: Graphical Representation on UI
    Note: To download the XML response, expand the Health check Response section and click the Download link in the upper-left corner of section.