Skip to main content

Quantela platform user manual

Quantela Data Ingestion

The Quantela Data Ingestion provider is a special type of provider. It is used by inbound Adapters to store entity and event data in the Quantela platform database. This data can subsequently be retrieved by the Quantela Data Connector provider for use in adapters and datasets.

To add a Quantela Data Ingestion provider to the data flow for an adapter, drag the corresponding provider icon from the palette on the left of the studio canvas.

updated_quantela_ingestion_adapter.png

Enter the following settings to configure the Quantela Data provider:

Configuration

Description

Domain

Select an application domain from the displayed list of domains that have been configured for this deployment of the Quantela platform.

Entity Type

Select a corresponding entity type. The list of valid entity types will depend on the domain selected above.

Event Type

Select a corresponding event type. The list of valid event types will depend on the entity type selected above.

Attribute Mapping

There are two ways to map data values from the adapter input to entity attributes in the Quantela platform database. The first is a tabular representation with the following columns:

  • Output Key - this is the name of an entity attribute that data is to be mapped to.

  • Output Type - this is the data-type of the entity specified above.

  • Value - this is the data value to be mapped to the selected entity attribute. This may be a static value, or alternatively it may be a dynamic value from the input data. In this case, the value should be entered in the following format:

    {{name:type}}

To add a new attribute, click on the '+' icon alongside the corresponding attribute type. Meta Properties are fixed, but Metric Properties can be added and removed as required.

To remove an attribute from the mapping, select the check-box to the left of the attribute then click the '-' icon alongside the Attribute Type heading.

To edit a mapping, click on the Value and in the Attribute Schema dialog displayed, edit the following properties as required:

  • Script - If enabled, you can enter the script for the attribute mapping.

  • Value – this is the data value mapped to the selected entity attribute.

  • Output Unit Transformation - You can convert one unit to another by selecting the desired conversion unit from the Convert To drop-down and the actual unit of the data received from the Convert From drop-down. For example, if the light intensity unit received is in lx then you can convert it to another unit like ft-cd.

  • Output Default Value – this is the default data value mapped to the selected entity attribute.

Raw

As an alternative to the tabular representation above, you can configure the attribute mapping manually by editing the JSON configuration. The Meta Properties and Metric Properties are represented as arrays of JSON objects, each with key, datatype and value attributes which correspond to the mapping columns above.

General Properties

The general properties of the entity.  If the ingestion type selected is entity, the options are the following:

  • Manufacturer - The manufacturer of the entity.

  • Provider - The provider of the entity.

If the ingestion type selected is event, the options are the following:

  • Entity ID - The ID of the entity.

  • Event Message - The info of the event.

  • Region ID - The ID of the region in which the event occurred. It is optional.

  • Criticality - The priority based on which we need to respond to this event.

You can click on the Full Screen icon new_full_screen_icon.png to maximize the side panel in the node configuration so that there is more real-estate to work on scripts. Also, you can click on the Help icon help.png to assist in using the provider.

Click the Save and Generate Schema button at the bottom of the Configuration panel to save the configuration with schema or Save Adapter to save the configuration without schema .