Versions Compared

Key

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

Getting started

This component helps you to automatically validate the project in the CleverMaps platform and ensure that nothing was broken in the data or configuration during the updates. Validation is configured with the set of checks.

Currently you can validate following scenarios:

  • All metrics are computable (real value is returned)

  • Metric value falls into the expected range

  • Column has expected distinct values (e.g. fixed string values which are used further in analysis)

  • Metric is computable on expected dimensions

Configuration

CleverMaps connection

Code Block
{
  "project_id": "<YOUR-CLEVERMAPS-PROJECT_ID>",
  "#access_token": "<YOUR-CLEVERMAPS-TOKEN>"
}

All metrics validation

Code Block
{
  "project_id": "<YOUR-CLEVERMAPS-PROJECT_ID>",
  "#access_token": "<YOUR-CLEVERMAPS-TOKEN>",
  "validations": {
    "metrics_all": []
  }
}

Expected metric values

Code Block
{
  "project_id": "<YOUR-CLEVERMAPS-PROJECT_ID>",
  "#access_token": "<YOUR-CLEVERMAPS-TOKEN>",
  "validations": {
    "metrics_expected": [
      {
        "metric": "<METRIC-NAME>",
        "expected_between": [
          <EXPECTED-MIN>,
          <EXPECTED-MAX>
        ]
      }
    ]
  }
}

Available datasets

Code Block
{
  "project_id": "<YOUR-CLEVERMAPS-PROJECT_ID>",
  "#access_token": "<YOUR-CLEVERMAPS-TOKEN>",
  "validations": {
    "available_datasets": [
      {
        "metric_name": "<METRIC-NAME>",
        "expected_datasets": [
          "<EXPECTED-DATASET-1>",
          "<EXPECTED-DATASET-2>"",
          "<EXPECTED-DATASET-3>""
        ]
      }
    ]
  }
}

Distinct column values

{ "project_id": "<YOUR-CLEVERMAPS-PROJECT_ID>", "#access_token": "<YOUR-CLEVERMAPS-TOKEN>", "validations": { "property_values": [ { "property_name": "<DATASET-NAME>.<COLUMN-NAME>", "expected_values": [ <EXPECTED-VALUE-1>, <EXPECTED-VALUE-2>, <EXPECTED-VALUE-3> ] } ] } }
Code Block
Panel
panelIconId1f389
panelIcon:tada:
panelIconText🎉
bgColor#E3FCEF

The content you are trying to reach has been moved here: https://docs.clevermaps.io/docs/projectvalidator-keboola

We are proud to announce that we have launched a new documentation.

Please update your saved links and bookmarks to follow a new address docs.clevermaps.io.