Manage Health Check Dashboard

Health Check Dashboard provides a view of the health of selected Environments. Click an Environment to see the health of the Environment over the past 24 hours and any associated TECRs and TEBRs.

Any health status recorded in Plutora will only be valid for a 24-hour period. If no updates are received within a 24-hour period, the current status will default back to No Data.

Set Up Health Check Dashboard

1. Environment Setup Customization

To enable the Health Check Dashboard:

  1. Go to Settings  > Customization > Environments.
  2. Click Environment Setup.
  3. Click to select Enable Health Check checkbox.
  4. Click Submit.
    The yellow Your changes have been saved pop up opens and closes.
    If you click away from the Customization page without clicking Submit, your changes will not save.

2. Update Environment Health Check Statuses via External APIs

See the Swagger article for how to generate a token and use Swagger to access Plutora’s external APIs.

The following API endpoints can be used to update Health Check Statuses:

  • POST /environmentHealthCheck
    • Populates the data in the Environment Health Check panel and Health Check Dashboard.
    • Include the following data:
      • Test Name.
      • Status.
      • An optional Log File or Test File as a text file attachment.
  • POST /environmentHealthCheck/FullHistory
  • POST /environmentHealthCheck/CurrentStatus

The following sample Integration Hub script will allow users to update their Environment Health Check Status via the API:

Manage Health Check Dashboard

To manage Health Check Dashboard:

  1. Go to Environment > Health Check Dashboard.
    If Health Check Dashboard does not appear under the Environment menu, enable it in Environment Setup.


    Health Check Dashboard displays nothing when first opened but remembers the previously selected filter from then on. 
  2. Click Select Filter. Available filters are:
    • Environments: Select the Environments to display one by one.
    • Environment Groups:
      • Display all the Environments in the selected Environment Groups.
      • Environment Groups are listed in the left-hand column and their Environments are visible in the same row.
    • Systems:
      • Display all the Environments in the selected Systems.
      • Systems are listed in the left-hand column and their Environments are visible in the same row.
  3. Type the search text.
  4. Press the Enter key on your keyboard.

    • The selected Environments display.
    • The colors mean:
      • Light gray: No data to display:
        • No data has been submitted via API.
        • Or the status submitted via API was 0 – Unknown:
        • If no status updates have been recorded for the last 24 hours, the current status will default to No Data.
      • Green: Environment is online. The status submitted via API was 1 – Online.
      • Amber: Environment has an issue. The status submitted via API was 3 – Issue.
      • Red: Environment is offline. The status submitted via API was 2 – Offline.
  5. Click an Environment to open the Environment health check details for the last 24 hours pop up.

    The timeline will backfill the most recently recorded status until the previous update, or for the prior 24 hour period if no updates exist for that period.
  6. Click to open the blue-linked TECRs and TEBRs.
    If the Environment is down, the dates of on the TECRs and TEBRs may give a clue to what brought it down.
  7. Click View History.
  8. The Environment Health Check History pop up opens.

    • Log files can now be added via the API.
    • The 24-hour history will show a detailed view of all status updates for the past 24 hours. If no updates have been received within a 24-hour period then nothing will be displayed.
  9. Click View to open a log file in a browser tab.

 

Back to the top arrow

Be the first to find out about new features. Subscribe to the Release Notes email. Subscribe Now
Updated on October 22, 2020