Apama 10.5.3 | Connecting Apama Applications to External Components | Standard Connectivity Plug-ins | The Cumulocity IoT Transport Connectivity Plug-in | Configuring the Cumulocity IoT transport
 
Configuring the Cumulocity IoT transport
Provide the following parameters in a YAML configuration file:
Configuration option
Description
requestAllDevices
Deprecated. Request all assets at startup.
Type: boolean.
Default: true.
Note:
requestAllDevices is set to false in the YAML configuration file. You should explicitly request for all available devices on startup using the com.apama.cumulocity.FindManagedObject API. For more information, see Sample EPL.
subscribeToAllMeasurements
Subscribe to measurements of all devices during startup.
Type: boolean.
Default: true.
subscribeToDevices
Subscribe to all device-related updates.
Type: boolean.
Default: true.
subscribeToOperations
Subscribe to all device operations.
Type: boolean.
Default: false.
Note:
subscribeToOperations is set to false by default when it is not explicitly specified in the YAML configuration file. However, for your convenience, when you add a new Cumulocity Client connectivity bundle in Software AG Designer or by using the apama_project tool, this option is already set to true in the resulting YAML configuration file.
tenant
Optional. Unique name of the application tenant. This configuration option is useful in the case of Cumulocity IoT Edge.
Type: string.
username
User name for authentication.
Type: string.
password
Password for authentication.
Type: string.
appKey
Unique key for the application defined on the Cumulocity IoT instance.
Type: string.
The application key is defined in Cumulocity IoT. Log in to your account in Cumulocity IoT, and use the Administration application to add an external application. You can then specify the application key and the URL of the application. See the Cumulocity IoT documentation at http://cumulocity.com/guides/ for more information.
url
URL of the Cumulocity IoT tenant.
Type: string.
forceInitialHost
By default, the endpoint details returned by the Cumulocity IoT platform are used. Set this to true if you want to configure the Cumulocity IoT SDK to always use the URL provided during session initialization instead of the endpoint details. This is helpful in deployment scenarios where the Cumulocity IoT instance is reachable only with an IP address.
Type: boolean.
Default: false.
For advanced cases, it is possible to tune the batching and status reporting by setting the following properties in a .properties configuration file:
Property
Description
CUMULOCITY_MAX_BATCH_SIZE
The maximum number of Apama events that can be batched as a single request before sending to Cumulocity IoT. The only event type that supports batching is com.apama.cumulocity.Measurement.
Default: 1000.
CUMULOCITY_LATENCY_SLOW_THRESHOLD_SECS
Update the mostRecentSlowRequestDetails status (see Monitoring status for Cumulocity IoT) if the time for fetching one page of response multiplied by the number of total pages is greater than this threshold.
Set this to 0 to disable updates.
Default: 1 second.
CUMULOCITY_LATENCY_LOG_THRESHOLD_SECS
Log a warning if a single-paged or multi-paged request takes more time to complete than defined by this threshold.
Set this to 0 to disable logging.
Default: 10 seconds.
CUMULOCITY_LATENCY_BATCH_THRESHOLD_SECS
Log a warning if a batch of requests takes more time to complete than defined by this threshold. If a warning for an individual request of the batch has already been logged with CUMULOCITY_LATENCY_LOG_THRESHOLD_SECS, then a warning for this batch is not logged.
Set this to 0 to disable logging.
Default: 50 seconds.