Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
titleINFO

Datameer X allows to validate all existing workbooksWorkbooks. The workbook Workbook health check validates whether any workbook Workbook has been broken. The results are presented in a report, downloadable as JSON. Admin rights are needed for thatto perform the Workbook Health Check.

Info
titleINFO

You can find the results and the error of the artifact also in the 'conductor.log'.

...

Health Check Information

The workbook health check Workbook Health Check presents the following information:

  • Workbook Health Check Graph: Visual indicator for all Workbooks and their dependencies 

  • Number of workbooks Workbooks in database: total  total amount of workbooksWorkbooks
  • Number of healthy workbooksWorkbooks: amount  amount of healthy workbooksWorkbooks
  • Number of broken workbooksWorkbooks: amount  amount of broken workbooksWorkbooks
  • IDs of broken workbooksWorkbooks: ID  ID of each broken workbookWorkbook, comma-separatedProgress status: status of health check
  • Last Workbook Health Report date: Date and time when the Workbook Health Report has been generated at
  • Health Check Log: status  status for each workbook Workbook - workbooks Workbooks with errors are shown with the workbook Workbook ID and the explicit error

Workbook Health Check Graph

The Workbook Health Check Graph presents all Workbooks with the current status as well as their dependencies to other Workbooks and source data. 

  • Workbooks with errors are displayed in red
  • Workbooks and source data without errors are displayed in green
  • arrows always point from the source data to the Workbook that is created out of it

When clicking a node, the following information is provided:

Source data:

  • file ID
  • source data name
  • file type
  • path
  • last execution date
  • dependencies between the source data and the Workbook  

Workbook: 

  • file ID
  • Workbook name
  • path
  • last execution date
  • if it was in an error state before
  • providers (of the source data)
  • errors with their error designation

Image Added

Workbook Health Check Execution

To execute a workbook Workbook health check:

  1. Reach the developer's page under <Datameer X URL>/dev and navigate to Open the "Admin" tab and then click on "Workbook Health Check".
    Image Removed  The Workbook Health Check page opens.
    Image Added
  2. Click on on "StartDownload Report" button. The workbook health check executes.Workbook Health Check executes. Find the report as a JSON file in your downloads. Workbook Health Check is finished.
    INFO: The execution time varies, based on the number and complexity of the existing workbooksWorkbooks. 
    INFO: A session timeout interrupts the workbook Workbook health check. You have to refresh the page and login again.
    Image Removed
  3. View the results. Workbook health check is finished.
    Image Removed
  4. Image Added

Cancelling a Running Check

To cancel a running Workbook Health Check click on "Abort"The check is cancelled. 

Workbook Health Check after an Upgrade

Info
titleINFO

After upgrading, rerun the workbook Workbook health check and ensure there are no broken items.

In case of broken Workbooks because of the upgrade, check the error messages contained in 'conductor.log'.