IntegrationButtonBlock

The purpose of this block is to enable interaction with third-party data providers through configurable parameters and caching mechanisms.

Below is a description of the available options and supported services:

1.1 Properties

Property Name
Description
Example

Button name

The display name of the button

Integration Data

Enable caching

If set to true, and the data was previously saved to the database (e.g., via the "sendToGuardian" block), future requests with the same parameters will retrieve the data from the cache instead of performing a new request.

Checked/unchecked

Integration

Type of integration. Currently supported values:

  • GLOBAL_FOREST_WATCH

  • KANOP_IO

  • WORLD_BANK

  • FIRM

KANOP_IO

Request type

The name of the specific request to execute (varies per integration).

getDatasets

Request params

Parameters required for the selected request. These are integration-specific.

datasets

1.2 Output Events

This block can emits the following events:

  • RunEvent

  • ReleaseEvent

  • RefreshEvent

To enable caching functionality, data must be saved to the database using the "sendToGuardian" block with the source set to auto or database. You can link the IntegrationButton to the "sendToGuardian" block using the RunEvent output event.

1.3 Supported Integrations

This block supports four third-party data providers:

1. Global Forest Watch

2. Kanop

3. World Bank Governance Indicators

4. NASA FIRMS

1.4 Request UI Parameters

Each integration has a list of supported requests and associated parameters. For each request parameter, two input methods are available:

Parameter
Description

Path field for ...

A Path input to extract data from an existing field.

Value for ...

A manual input for static values (e.g., known dataset names).

Note: If both fields are filled, "Value for ..." takes precedence.

Last updated