https://github.com/Cumulocity-IoT/apama-analytics-builder-block-sdk
Apama Analytics Builder Block SDK
https://github.com/Cumulocity-IoT/apama-analytics-builder-block-sdk
apama apama-analytics-builder apama-in-cumulocity iot-analytics sdk
Last synced: 1 day ago
JSON representation
Apama Analytics Builder Block SDK
- Host: GitHub
- URL: https://github.com/Cumulocity-IoT/apama-analytics-builder-block-sdk
- Owner: Cumulocity-IoT
- License: apache-2.0
- Created: 2019-05-31T16:33:57.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-30T13:44:41.000Z (3 days ago)
- Last Synced: 2025-04-30T15:04:57.132Z (3 days ago)
- Topics: apama, apama-analytics-builder, apama-in-cumulocity, iot-analytics, sdk
- Language: Python
- Homepage:
- Size: 8.08 MB
- Stars: 11
- Watchers: 8
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-softwareag - apama-analytics-builder-block-sdk - A Software Development Kit (SDK) for producing blocks for the Apama Analytics Builder Block SDK. (IoT & Analytics /  Apama)
README
# Apama Analytics Builder Block SDK
This is a Software Development Kit (SDK) for producing blocks for the Apama Analytics Builder.
## Disclaimer
These tools are provided as-is and without warranty or support. They do not constitute part of the product suite. Users are free to use, fork and modify them, subject to the license agreement. While we welcome contributions, we cannot guarantee to include every contribution in the main project.
## Licensing
Copyright 2019-present Cumulocity GmbH
This project is licensed under the Apache 2.0 license - see
This excludes the Analytics Framework 'CDP' file, which is provided in binary form only for the purpose of testing.
## Analytics Builder version
Use the 'main' branch for the current release or switch to the appropriate branch for Long-term support (LTS) / Maintenance releases.
## System requirements
This script requires an installation of Python 3.7+ and runs on either Windows or Linux. To build extensions or edit them using the [Apama extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ApamaCommunity.apama-extensions), a `dev` installation of the latest Apama is required. You can download the package from [Apama Downloads](https://download.cumulocity.com/Apama). If you choose to install Apama, you can skip the manual installation of Python, as it is shipped with Apama.
Alternatively, the [apama-builder](https://gallery.ecr.aws/apama/apama-builder) Docker image from Amazon ECR Public Gallery can also be used for building and managing extensions.
Note that Analytics Builder requires your Cumulocity IoT tenant to be subscribed to an 'apama-ctrl' microservice. The 'apama-ctrl-starter' microservice offers only restricted functionality and does not support custom blocks.
## Documentation
The guide to writing blocks is available in the [doc directory](doc/000-contents.md) and there is [ApamaDoc reference](https://cumulocity-iot.github.io/apama-analytics-builder-block-sdk/doc/apamadoc/index.html) available.
## Getting started
From an Apama command prompt:
* Run sample tests (Unix):
```bash
export ANALYTICS_BUILDER_SDK=`pwd`
cd samples/tests
pysys run
```
* Package samples as an extension and upload:
```bash
analytics_builder build extension --input samples/blocks --cumulocity_url --username / --password --name sample-blocks --restart
```
> **Note:** After running the above command, the apama-ctrl microservice will be restarted.
## Change Log
See [Change Log](CHANGELOG.md) for changes.
## Migration of input and output blocks to the version 2 API
See [Migrating input and output blocks to the version 2 API](doc/150-MigrateInputOutputBlocks.md) for details on migrating custom input and output blocks to the version 2 API.