Configuration

Soracom Harvest settings are found in Soracom Air or Soracom Inventory group settings. To send data to Harvest, refer to the Harvest Data section below. To upload files to Harvest, refer to the Harvest Files section below.

Harvest Data

Enabling Harvest Data will incur fees based on the number of devices where the service is enabled. Refer to the Pricing & Fee Schedule for more information.

Harvest Data settings are shared among all device types within the same group. That means that enabling Harvest for one device type (cellular, Sigfox, LoRaWAN, or Inventory) will also enable Harvest for other device types within that group.

To configure Harvest, open the settings page of the group that you want to configure.

Underneath the Basic Settings tab, click the SORACOM Harvest Data panel to expand its settings.

Harvest Data configuration

Enable Harvest Data by switching the option to ON.

Harvest Files

Enabling Harvest Files will incur fees based on the amount of data uploaded or downloaded. Refer to the Pricing & Fee Schedule for more information.

Harvest Files settings are only available for Air for Cellular devices.

To configure Harvest Files, open the settings page of the group that you want to configure.

Underneath the Basic Settings tab, click the SORACOM Harvest Files panel to expand its settings.

Harvest Files configuration

Enable Harvest Files by switching the option to ON.

Parameters

Harvest Files allows you to configure options to control where files are saved, and how uploaded files can be accessed by devices.

In addition, the Log file uploading event to Harvest Data option allows you to create a data entry in Harvest Data whenever a file is uploaded, consisting of the file path and upload timestamp. This option can be combined with the Dynamic Image Panel in Lagoon in order to dynamically show new images in a Lagoon dashboard as they are uploaded from a device.

Harvest Data does not need to be enabled in order to use the Log file uploading event to Harvest Data option. In addition, file upload events that are logged to Harvest Data do not incur any Harvest Data fees service fees.

The Log file uploading event to Harvest Data option will only log file upload events for files that are uploaded using a cellular connection (http://harvest-files.soracom.io entry point). Files uploaded through the https://api.soracom.io/v1/files/private API entry point will not be logged to Harvest Data.


Advanced Configuration

Harvest Data and Harvest Files can also be configured through the Soracom API or CLI by using the SoracomHarvest and SoracomHarvesetFiles namespaces, respectively.

Configuration Structure

For Harvest Data, the group configuration looks like this:

"SoracomHarvest": {
  "enabled": true|false
}

For Harvest Files, the group configuration looks like this:

"SoracomHarvestFiles": {
  "enabled": true|false,
  "defaultPath": "/path/to/file",
  "assumedRoleId": "myRole",
  "logFileUploadingEventToHarvestData": {
    "enabled": true,
    "pathPatterns": [
      "/lagoon/.*"
    ]
  }
}

Parameters

For the SoracomHarvest namespace:

Enable or disable Harvest Data:

For the SoracomHarvestFiles namespace:

Enable or disable Harvest Files:

Set the default path for upload files:

Control the device read and write permissions:

Configure Log file uploading event to Harvest Data option:

Sample

Enable Harvest Data:

[
  {
    "key": "enabled",
    "value": true
  }
]

Enable Harvest Files, while specifying that each file uploaded should be given a file path (filename) according to the IMSI of the subscriber, and the timestamp when the file is uploaded:

[
  {
    "key": "enabled",
    "value": true
  },
  {
    "key": "defaultPath",
    "value": "/:imsi/:time"
  }
]