You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by gi...@apache.org on 2023/01/18 12:00:07 UTC
[streampipes-website] branch asf-site updated: Automated deployment: Wed Jan 18 11:59:57 UTC 2023 470009f80ebb2d7b405f787ab7dbe969f9744772
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/streampipes-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 0e01ffcc Automated deployment: Wed Jan 18 11:59:57 UTC 2023 470009f80ebb2d7b405f787ab7dbe969f9744772
0e01ffcc is described below
commit 0e01ffcc11dc7b81568df37e2778ade502bf8726
Author: dominikriemer <do...@users.noreply.github.com>
AuthorDate: Wed Jan 18 11:59:57 2023 +0000
Automated deployment: Wed Jan 18 11:59:57 UTC 2023 470009f80ebb2d7b405f787ab7dbe969f9744772
---
docs/blog/2018/06/14/welcome.html | 2 +-
.../06/18/how-to-understand-your-machine-data.html | 2 +-
docs/blog/2018/09/17/preview-060.html | 2 +-
docs/blog/2018/11/24/container-cli.html | 2 +-
docs/blog/2019/04/04/release-0610.html | 2 +-
docs/blog/2019/05/23/release-0620.html | 2 +-
docs/blog/2019/09/05/release-0630.html | 2 +-
docs/blog/2019/09/19/release-0640.html | 2 +-
docs/blog/2019/11/23/release-0650.html | 2 +-
.../2019/11/25/moving-to-the-apache-incubator.html | 2 +-
docs/blog/2020/01/23/streampipes_on_rpi.html | 2 +-
docs/blog/2020/05/19/release-0660.html | 2 +-
docs/blog/2020/05/27/streampipes_on_k3s.html | 2 +-
docs/blog/2021/07/22_release/0680.html | 2 +-
docs/blog/2022/03/21_release/0690.html | 2 +-
.../09/05/using-factory.io-with-streampipes.html | 2 +-
docs/blog/2022/10/13/release-070.html | 2 +-
docs/blog/2023/01/17/release-090.html | 162 ++
docs/blog/assets/2023-01-17/github-discussions.png | Bin 0 -> 437214 bytes
docs/blog/atom.xml | 17 +-
docs/blog/feed.xml | 13 +-
docs/blog/index.html | 14 +-
docs/blog/page2/index.html | 8 +-
docs/css/main.css | 2 +-
docs/docs/0.70.0/community-contribute.html | 93 +
docs/docs/0.70.0/community-get-help.html | 92 +
docs/docs/0.70.0/concepts-adapter.html | 27 +
docs/docs/0.70.0/concepts-data-streams.html | 27 +
docs/docs/0.70.0/concepts-glossary.html | 27 +
docs/docs/0.70.0/concepts-overview.html | 105 +
docs/docs/0.70.0/concepts-pipelines.html | 27 +
docs/docs/0.70.0/debugging-debugging.html | 27 +
docs/docs/0.70.0/debugging-monitoring.html | 27 +
docs/docs/0.70.0/deploy-docker.html | 138 +
docs/docs/0.70.0/deploy-kubernetes.html | 130 +
docs/docs/0.70.0/deploy-security.html | 130 +
docs/docs/0.70.0/deploy-use-ssl.html | 106 +
docs/docs/0.70.0/dev-guide-archetype.html | 82 +
docs/docs/0.70.0/dev-guide-architecture.html | 121 +
docs/docs/0.70.0/dev-guide-configuration.html | 125 +
.../0.70.0/dev-guide-development-environment.html | 175 ++
docs/docs/0.70.0/dev-guide-event-model.html | 175 ++
docs/docs/0.70.0/dev-guide-introduction.html | 115 +
docs/docs/0.70.0/dev-guide-migration.html | 243 ++
docs/docs/0.70.0/dev-guide-output-strategies.html | 340 +++
.../0.70.0/dev-guide-sdk-guide-processors.html | 86 +
docs/docs/0.70.0/dev-guide-sdk-guide-sinks.html | 86 +
docs/docs/0.70.0/dev-guide-sdk-guide-sources.html | 142 ++
docs/docs/0.70.0/dev-guide-ssl.html | 106 +
docs/docs/0.70.0/dev-guide-static-properties.html | 237 ++
.../docs/0.70.0/dev-guide-stream-requirements.html | 214 ++
.../docs/0.70.0/dev-guide-tutorial-processors.html | 473 ++++
docs/docs/0.70.0/dev-guide-tutorial-sinks.html | 277 ++
docs/docs/0.70.0/dev-guide-tutorial-sources.html | 302 +++
docs/docs/0.70.0/extend-archetypes.html | 124 +
docs/docs/0.70.0/extend-cli.html | 227 ++
docs/docs/0.70.0/extend-first-processor.html | 119 +
docs/docs/0.70.0/extend-sdk-event-model.html | 175 ++
.../extend-sdk-migration-service-discovery.html | 164 ++
docs/docs/0.70.0/extend-sdk-output-strategies.html | 342 +++
docs/docs/0.70.0/extend-sdk-static-properties.html | 239 ++
.../0.70.0/extend-sdk-stream-requirements.html | 214 ++
docs/docs/0.70.0/extend-setup.html | 111 +
.../0.70.0/extend-tutorial-data-processors.html | 357 +++
docs/docs/0.70.0/extend-tutorial-data-sinks.html | 269 ++
docs/docs/0.70.0/extend-tutorial-data-sources.html | 240 ++
docs/docs/0.70.0/faq-common-problems.html | 131 +
...org.apache.streampipes.processor.geo.flink.html | 58 +
...he.streampipes.processor.geo.jvm.geocoding.html | 57 +
...ampipes.processor.geo.jvm.reversegeocoding.html | 56 +
...eampipes.processor.geo.jvm.staticgeocoding.html | 58 +
...ification.jvm.generic-image-classification.html | 58 +
...sor.imageclassification.jvm.image-enricher.html | 58 +
...pipes.processor.imageclassification.qrcode.html | 58 +
...s.processors.aggregation.flink.aggregation.html | 64 +
...es.processors.aggregation.flink.eventcount.html | 54 +
...eampipes.processors.aggregation.flink.rate.html | 57 +
...ssors.enricher.flink.processor.math.mathop.html | 62 +
...enricher.flink.processor.math.staticmathop.html | 62 +
...sors.enricher.flink.processor.trigonometry.html | 61 +
....enricher.flink.processor.urldereferencing.html | 59 +
...mpipes.processors.enricher.flink.timestamp.html | 57 +
...mpipes.processors.enricher.jvm.sizemeasure.html | 40 +
...streampipes.processors.filters.jvm.compose.html | 58 +
....streampipes.processors.filters.jvm.enrich.html | 62 +
...e.streampipes.processors.filters.jvm.merge.html | 65 +
...pes.processors.filters.jvm.numericalfilter.html | 62 +
...processors.filters.jvm.numericaltextfilter.html | 70 +
...streampipes.processors.filters.jvm.project.html | 57 +
...eampipes.processors.filters.jvm.textfilter.html | 60 +
...reampipes.processors.filters.jvm.threshold.html | 62 +
...ssors.geo.jvm.processor.distancecalculator.html | 58 +
...ors.pattern-detection.flink.peak-detection.html | 58 +
...he.streampipes.processors.siddhi.frequency.html | 56 +
...eampipes.processors.siddhi.frequencychange.html | 58 +
...che.streampipes.processors.siddhi.increase.html | 58 +
...eampipes.processors.siddhi.numericalfilter.html | 57 +
...che.streampipes.processors.siddhi.sequence.html | 58 +
....apache.streampipes.processors.siddhi.stop.html | 58 +
...cessors.textmining.flink.languagedetection.html | 58 +
...ipes.processors.textmining.flink.wordcount.html | 58 +
...eampipes.processors.textmining.jvm.chunker.html | 71 +
...rocessors.textmining.jvm.languagedetection.html | 171 ++
...pipes.processors.textmining.jvm.namefinder.html | 64 +
...pes.processors.textmining.jvm.partofspeech.html | 65 +
...rocessors.textmining.jvm.sentencedetection.html | 60 +
...mpipes.processors.textmining.jvm.tokenizer.html | 60 +
...ssors.transformation.flink.field-converter.html | 58 +
...ocessors.transformation.flink.field-mapper.html | 58 +
...cessors.transformation.flink.field-renamer.html | 58 +
...rocessors.transformation.flink.fieldhasher.html | 58 +
...formation.flink.measurement-unit-converter.html | 58 +
...transformation.flink.processor.boilerplate.html | 58 +
...rs.transformation.jvm.booloperator.counter.html | 68 +
...s.transformation.jvm.booloperator.inverter.html | 58 +
...ransformation.jvm.booloperator.timekeeping.html | 73 +
...sors.transformation.jvm.booloperator.timer.html | 60 +
...rocessors.transformation.jvm.changed-value.html | 57 +
....processors.transformation.jvm.count-array.html | 59 +
....processors.transformation.jvm.csvmetadata.html | 50 +
...ocessors.transformation.jvm.duration-value.html | 58 +
...formation.jvm.processor.timestampextractor.html | 60 +
....processors.transformation.jvm.split-array.html | 62 +
...processors.transformation.jvm.taskduration.html | 57 +
...rs.transformation.jvm.transform-to-boolean.html | 40 +
...e.streampipes.sinks.brokers.jvm.bufferrest.html | 61 +
...g.apache.streampipes.sinks.brokers.jvm.jms.html | 62 +
...apache.streampipes.sinks.brokers.jvm.kafka.html | 62 +
...pache.streampipes.sinks.brokers.jvm.pulsar.html | 62 +
...che.streampipes.sinks.brokers.jvm.rabbitmq.html | 69 +
....apache.streampipes.sinks.brokers.jvm.rest.html | 58 +
...g.apache.streampipes.sinks.databases.ditto.html | 63 +
...mpipes.sinks.databases.flink.elasticsearch.html | 61 +
...he.streampipes.sinks.databases.jvm.couchdb.html | 63 +
...e.streampipes.sinks.databases.jvm.influxdb.html | 74 +
...ache.streampipes.sinks.databases.jvm.iotdb.html | 67 +
...ache.streampipes.sinks.databases.jvm.opcua.html | 67 +
...streampipes.sinks.databases.jvm.postgresql.html | 68 +
...e.streampipes.sinks.internal.jvm.dashboard.html | 58 +
...he.streampipes.sinks.internal.jvm.datalake.html | 74 +
...treampipes.sinks.internal.jvm.notification.html | 60 +
....streampipes.sinks.notifications.jvm.email.html | 66 +
...eampipes.sinks.notifications.jvm.onesignal.html | 63 +
....streampipes.sinks.notifications.jvm.slack.html | 67 +
...ache.streampipes.connect.adapters.coindesk.html | 109 +
...che.streampipes.connect.adapters.flic.mqtt.html | 118 +
....apache.streampipes.connect.adapters.gdelt.html | 108 +
...ache.streampipes.connect.adapters.iex.news.html | 112 +
...he.streampipes.connect.adapters.iex.stocks.html | 112 +
...che.streampipes.connect.adapters.image.set.html | 106 +
....streampipes.connect.adapters.image.stream.html | 106 +
....streampipes.connect.adapters.influxdb.set.html | 107 +
...reampipes.connect.adapters.influxdb.stream.html | 107 +
...rg.apache.streampipes.connect.adapters.iss.html | 106 +
...che.streampipes.connect.adapters.mysql.set.html | 106 +
....streampipes.connect.adapters.mysql.stream.html | 106 +
...he.streampipes.connect.adapters.netio.mqtt.html | 118 +
...he.streampipes.connect.adapters.netio.rest.html | 118 +
...onnect.adapters.nswaustralia.trafficcamera.html | 106 +
....apache.streampipes.connect.adapters.opcua.html | 127 +
....streampipes.connect.adapters.plc4x.modbus.html | 106 +
...ache.streampipes.connect.adapters.plc4x.s7.html | 106 +
...rg.apache.streampipes.connect.adapters.ros.html | 117 +
...ampipes.connect.adapters.simulator.machine.html | 112 +
...s.connect.adapters.simulator.randomdataset.html | 106 +
...onnect.adapters.simulator.randomdatastream.html | 106 +
....apache.streampipes.connect.adapters.slack.html | 106 +
...org.apache.streampipes.connect.adapters.ti.html | 115 +
...treampipes.connect.adapters.wikipedia.edit.html | 106 +
...streampipes.connect.adapters.wikipedia.new.html | 106 +
...e.streampipes.connect.protocol.stream.file.html | 106 +
...e.streampipes.connect.protocol.stream.http.html | 106 +
...ampipes.connect.protocol.stream.httpserver.html | 106 +
....streampipes.connect.protocol.stream.kafka.html | 106 +
...e.streampipes.connect.protocol.stream.mqtt.html | 113 +
...streampipes.connect.protocol.stream.pulsar.html | 106 +
...org.apache.streampipes.processor.geo.flink.html | 118 +
...he.streampipes.processor.geo.jvm.geocoding.html | 119 +
...ampipes.processor.geo.jvm.reversegeocoding.html | 120 +
...eampipes.processor.geo.jvm.staticgeocoding.html | 120 +
...ification.jvm.generic-image-classification.html | 114 +
...ssor.imageclassification.jvm.image-cropper.html | 111 +
...sor.imageclassification.jvm.image-enricher.html | 110 +
...pipes.processor.imageclassification.qrcode.html | 123 +
...s.processors.aggregation.flink.aggregation.html | 120 +
...ampipes.processors.aggregation.flink.count.html | 128 +
...es.processors.aggregation.flink.eventcount.html | 118 +
...eampipes.processors.aggregation.flink.rate.html | 117 +
...pipes.processors.changedetection.jvm.cusum.html | 126 +
...ssors.enricher.flink.processor.math.mathop.html | 118 +
...enricher.flink.processor.math.staticmathop.html | 118 +
...sors.enricher.flink.processor.trigonometry.html | 117 +
....enricher.flink.processor.urldereferencing.html | 115 +
...mpipes.processors.enricher.flink.timestamp.html | 113 +
...mpipes.processors.enricher.jvm.sizemeasure.html | 113 +
...streampipes.processors.filters.jvm.compose.html | 114 +
....streampipes.processors.filters.jvm.enrich.html | 118 +
...e.streampipes.processors.filters.jvm.limit.html | 131 +
...e.streampipes.processors.filters.jvm.merge.html | 121 +
...pes.processors.filters.jvm.numericalfilter.html | 118 +
...processors.filters.jvm.numericaltextfilter.html | 126 +
...streampipes.processors.filters.jvm.project.html | 113 +
...eampipes.processors.filters.jvm.textfilter.html | 116 +
...reampipes.processors.filters.jvm.threshold.html | 118 +
...ocessors.geo.jvm.jts.processor.latLngToGeo.html | 132 +
...s.processors.geo.jvm.jts.processor.setEPSG.html | 117 +
...rocessors.geo.jvm.jts.processor.trajectory.html | 145 ++
...ssors.geo.jvm.processor.distancecalculator.html | 122 +
...ampipes.processors.geo.jvm.processor.speed.html | 116 +
...geo.jvm.processor.staticdistancecalculator.html | 123 +
...processors.pattern-detection.flink.absence.html | 113 +
...pes.processors.pattern-detection.flink.and.html | 113 +
...ors.pattern-detection.flink.peak-detection.html | 113 +
...rocessors.pattern-detection.flink.sequence.html | 113 +
...he.streampipes.processors.siddhi.frequency.html | 114 +
...eampipes.processors.siddhi.frequencychange.html | 116 +
...che.streampipes.processors.siddhi.increase.html | 120 +
...eampipes.processors.siddhi.numericalfilter.html | 123 +
...che.streampipes.processors.siddhi.sequence.html | 105 +
....apache.streampipes.processors.siddhi.stop.html | 116 +
...essors.statistics.flink.statistics-summary.html | 113 +
...cessors.textmining.flink.languagedetection.html | 113 +
...ipes.processors.textmining.flink.wordcount.html | 113 +
...eampipes.processors.textmining.jvm.chunker.html | 129 +
...rocessors.textmining.jvm.languagedetection.html | 229 ++
...pipes.processors.textmining.jvm.namefinder.html | 120 +
...pes.processors.textmining.jvm.partofspeech.html | 123 +
...rocessors.textmining.jvm.sentencedetection.html | 118 +
...mpipes.processors.textmining.jvm.tokenizer.html | 118 +
...ssors.transformation.flink.field-converter.html | 116 +
...ocessors.transformation.flink.field-mapper.html | 134 +
...cessors.transformation.flink.field-renamer.html | 126 +
...rocessors.transformation.flink.fieldhasher.html | 117 +
...formation.flink.measurement-unit-converter.html | 113 +
...transformation.flink.processor.boilerplate.html | 113 +
...rs.transformation.jvm.booloperator.counter.html | 124 +
...s.transformation.jvm.booloperator.inverter.html | 114 +
...ransformation.jvm.booloperator.timekeeping.html | 129 +
...sors.transformation.jvm.booloperator.timer.html | 116 +
...rocessors.transformation.jvm.changed-value.html | 111 +
....processors.transformation.jvm.count-array.html | 115 +
....processors.transformation.jvm.csvmetadata.html | 138 +
...ocessors.transformation.jvm.duration-value.html | 117 +
...sformation.jvm.processor.booloperator.edge.html | 122 +
...formation.jvm.processor.booloperator.state.html | 121 +
....transformation.jvm.processor.state.buffer.html | 117 +
...rmation.jvm.processor.state.labeler.buffer.html | 124 +
...rmation.jvm.processor.state.labeler.number.html | 118 +
...rmation.jvm.processor.stringoperator.state.html | 116 +
...formation.jvm.processor.timestampextractor.html | 116 +
....processors.transformation.jvm.split-array.html | 117 +
....transformation.jvm.stringoperator.counter.html | 122 +
...rs.transformation.jvm.stringoperator.timer.html | 121 +
...processors.transformation.jvm.taskduration.html | 113 +
...rs.transformation.jvm.transform-to-boolean.html | 114 +
.../org.apache.streampipes.protocol.set.file.html | 106 +
.../org.apache.streampipes.protocol.set.http.html | 106 +
...e.streampipes.sinks.brokers.jvm.bufferrest.html | 117 +
...g.apache.streampipes.sinks.brokers.jvm.jms.html | 118 +
...apache.streampipes.sinks.brokers.jvm.kafka.html | 118 +
....apache.streampipes.sinks.brokers.jvm.mqtt.html | 62 +
....apache.streampipes.sinks.brokers.jvm.nats.html | 128 +
...pache.streampipes.sinks.brokers.jvm.pulsar.html | 118 +
...che.streampipes.sinks.brokers.jvm.rabbitmq.html | 124 +
....apache.streampipes.sinks.brokers.jvm.rest.html | 114 +
...g.apache.streampipes.sinks.databases.ditto.html | 124 +
...mpipes.sinks.databases.flink.elasticsearch.html | 117 +
...he.streampipes.sinks.databases.jvm.couchdb.html | 119 +
...e.streampipes.sinks.databases.jvm.influxdb.html | 130 +
...ache.streampipes.sinks.databases.jvm.iotdb.html | 123 +
...ache.streampipes.sinks.databases.jvm.mysql.html | 124 +
...ache.streampipes.sinks.databases.jvm.opcua.html | 123 +
...streampipes.sinks.databases.jvm.postgresql.html | 124 +
...e.streampipes.sinks.internal.jvm.dashboard.html | 114 +
...he.streampipes.sinks.internal.jvm.datalake.html | 130 +
...treampipes.sinks.internal.jvm.notification.html | 116 +
....streampipes.sinks.notifications.jvm.email.html | 122 +
...eampipes.sinks.notifications.jvm.onesignal.html | 119 +
....streampipes.sinks.notifications.jvm.slack.html | 122 +
...reampipes.sinks.notifications.jvm.telegram.html | 133 +
docs/docs/0.70.0/pipeline-elements.html | 26 +
docs/docs/0.70.0/privacy.html | 54 +
docs/docs/0.70.0/technicals-architecture.html | 121 +
docs/docs/0.70.0/technicals-configuration.html | 69 +
docs/docs/0.70.0/technicals-messaging.html | 83 +
docs/docs/0.70.0/technicals-runtime-wrappers.html | 83 +
docs/docs/0.70.0/technicals-user-guidance.html | 83 +
docs/docs/0.70.0/try-installation.html | 193 ++
docs/docs/0.70.0/try-tutorial.html | 91 +
docs/docs/0.70.0/use-configurations.html | 104 +
docs/docs/0.70.0/use-connect.html | 129 +
docs/docs/0.70.0/use-dashboard.html | 129 +
docs/docs/0.70.0/use-data-explorer.html | 131 +
.../docs/0.70.0/use-install-pipeline-elements.html | 84 +
docs/docs/0.70.0/use-managing-pipelines.html | 114 +
docs/docs/0.70.0/use-notifications.html | 92 +
docs/docs/0.70.0/use-pipeline-editor.html | 129 +
docs/docs/0.70.0/user-guide-first-steps.html | 231 ++
docs/docs/0.70.0/user-guide-getting-started.html | 240 ++
docs/docs/0.70.0/user-guide-installation.html | 126 +
docs/docs/0.70.0/user-guide-introduction-old.html | 68 +
docs/docs/0.70.0/user-guide-introduction.html | 190 ++
.../0.70.0/user-guide-processing-elements.html | 133 +
.../0.70.0/user-guide-software-components.html | 300 +++
docs/docs/0.70.0/user-guide-tour.html | 276 ++
docs/docs/community-contribute.html | 8 +-
docs/docs/community-get-help.html | 6 +-
docs/docs/concepts-adapter.html | 4 +-
docs/docs/concepts-data-streams.html | 4 +-
docs/docs/concepts-glossary.html | 4 +-
docs/docs/concepts-overview.html | 6 +-
docs/docs/concepts-pipelines.html | 4 +-
docs/docs/debugging-debugging.html | 4 +-
docs/docs/debugging-monitoring.html | 4 +-
docs/docs/deploy-docker.html | 4 +-
docs/docs/deploy-kubernetes.html | 4 +-
docs/docs/deploy-security.html | 4 +-
docs/docs/deploy-use-ssl.html | 4 +-
docs/docs/dev-guide-archetype.html | 60 +-
docs/docs/dev-guide-architecture.html | 62 +-
docs/docs/dev-guide-configuration.html | 62 +-
docs/docs/dev-guide-development-environment.html | 62 +-
docs/docs/dev-guide-event-model.html | 62 +-
docs/docs/dev-guide-introduction.html | 62 +-
docs/docs/dev-guide-migration.html | 62 +-
docs/docs/dev-guide-output-strategies.html | 62 +-
docs/docs/dev-guide-sdk-guide-processors.html | 62 +-
docs/docs/dev-guide-sdk-guide-sinks.html | 62 +-
docs/docs/dev-guide-sdk-guide-sources.html | 62 +-
docs/docs/dev-guide-ssl.html | 62 +-
docs/docs/dev-guide-static-properties.html | 62 +-
docs/docs/dev-guide-stream-requirements.html | 62 +-
docs/docs/dev-guide-tutorial-processors.html | 62 +-
docs/docs/dev-guide-tutorial-sinks.html | 62 +-
docs/docs/dev-guide-tutorial-sources.html | 62 +-
docs/docs/extend-archetypes.html | 4 +-
docs/docs/extend-cli.html | 10 +-
docs/docs/extend-first-processor.html | 4 +-
docs/docs/extend-sdk-event-model.html | 6 +-
docs/docs/extend-sdk-functions.html | 182 ++
.../extend-sdk-migration-service-discovery.html | 6 +-
docs/docs/extend-sdk-output-strategies.html | 6 +-
docs/docs/extend-sdk-static-properties.html | 6 +-
docs/docs/extend-sdk-stream-requirements.html | 6 +-
docs/docs/extend-setup.html | 6 +-
docs/docs/extend-tutorial-data-processors.html | 39 +-
docs/docs/extend-tutorial-data-sinks.html | 13 +-
docs/docs/extend-tutorial-data-sources.html | 24 +-
docs/docs/faq-common-problems.html | 4 +-
docs/docs/next/community-contribute.html | 2 +-
docs/docs/next/community-get-help.html | 2 +-
docs/docs/next/concepts-overview.html | 4 +-
docs/docs/next/deploy-docker.html | 2 +-
docs/docs/next/deploy-kubernetes.html | 2 +-
docs/docs/next/deploy-security.html | 2 +-
docs/docs/next/deploy-use-ssl.html | 2 +-
docs/docs/next/extend-archetypes.html | 2 +-
docs/docs/next/extend-cli.html | 2 +-
docs/docs/next/extend-first-processor.html | 2 +-
docs/docs/next/extend-sdk-event-model.html | 2 +-
docs/docs/next/extend-sdk-functions.html | 2 +-
.../extend-sdk-migration-service-discovery.html | 2 +-
docs/docs/next/extend-sdk-output-strategies.html | 2 +-
docs/docs/next/extend-sdk-static-properties.html | 2 +-
docs/docs/next/extend-sdk-stream-requirements.html | 2 +-
docs/docs/next/extend-setup.html | 2 +-
.../docs/next/extend-tutorial-data-processors.html | 2 +-
docs/docs/next/extend-tutorial-data-sinks.html | 2 +-
docs/docs/next/extend-tutorial-data-sources.html | 2 +-
...ache.streampipes.connect.adapters.coindesk.html | 2 +-
...che.streampipes.connect.adapters.flic.mqtt.html | 2 +-
....apache.streampipes.connect.adapters.gdelt.html | 2 +-
...ache.streampipes.connect.adapters.iex.news.html | 2 +-
...he.streampipes.connect.adapters.iex.stocks.html | 2 +-
...che.streampipes.connect.adapters.image.set.html | 2 +-
....streampipes.connect.adapters.image.stream.html | 2 +-
....streampipes.connect.adapters.influxdb.set.html | 2 +-
...reampipes.connect.adapters.influxdb.stream.html | 2 +-
...rg.apache.streampipes.connect.adapters.iss.html | 2 +-
...che.streampipes.connect.adapters.mysql.set.html | 2 +-
....streampipes.connect.adapters.mysql.stream.html | 2 +-
...he.streampipes.connect.adapters.netio.mqtt.html | 2 +-
...he.streampipes.connect.adapters.netio.rest.html | 2 +-
...onnect.adapters.nswaustralia.trafficcamera.html | 2 +-
....apache.streampipes.connect.adapters.opcua.html | 2 +-
....streampipes.connect.adapters.plc4x.modbus.html | 2 +-
...ache.streampipes.connect.adapters.plc4x.s7.html | 2 +-
...rg.apache.streampipes.connect.adapters.ros.html | 2 +-
...ampipes.connect.adapters.simulator.machine.html | 2 +-
...s.connect.adapters.simulator.randomdataset.html | 2 +-
...onnect.adapters.simulator.randomdatastream.html | 2 +-
....apache.streampipes.connect.adapters.slack.html | 2 +-
...org.apache.streampipes.connect.adapters.ti.html | 2 +-
...treampipes.connect.adapters.wikipedia.edit.html | 2 +-
...streampipes.connect.adapters.wikipedia.new.html | 2 +-
...e.streampipes.connect.protocol.stream.file.html | 2 +-
...e.streampipes.connect.protocol.stream.http.html | 2 +-
...ampipes.connect.protocol.stream.httpserver.html | 2 +-
....streampipes.connect.protocol.stream.kafka.html | 2 +-
...e.streampipes.connect.protocol.stream.mqtt.html | 2 +-
...streampipes.connect.protocol.stream.pulsar.html | 2 +-
...org.apache.streampipes.processor.geo.flink.html | 2 +-
...he.streampipes.processor.geo.jvm.geocoding.html | 2 +-
...ampipes.processor.geo.jvm.reversegeocoding.html | 2 +-
...eampipes.processor.geo.jvm.staticgeocoding.html | 2 +-
...ification.jvm.generic-image-classification.html | 2 +-
...ssor.imageclassification.jvm.image-cropper.html | 2 +-
...sor.imageclassification.jvm.image-enricher.html | 2 +-
...pipes.processor.imageclassification.qrcode.html | 2 +-
...s.processors.aggregation.flink.aggregation.html | 2 +-
...ampipes.processors.aggregation.flink.count.html | 2 +-
...es.processors.aggregation.flink.eventcount.html | 2 +-
...eampipes.processors.aggregation.flink.rate.html | 2 +-
...pipes.processors.changedetection.jvm.cusum.html | 2 +-
...ssors.enricher.flink.processor.math.mathop.html | 2 +-
...enricher.flink.processor.math.staticmathop.html | 2 +-
...sors.enricher.flink.processor.trigonometry.html | 2 +-
....enricher.flink.processor.urldereferencing.html | 2 +-
...mpipes.processors.enricher.flink.timestamp.html | 2 +-
...mpipes.processors.enricher.jvm.sizemeasure.html | 2 +-
...streampipes.processors.filters.jvm.compose.html | 2 +-
....streampipes.processors.filters.jvm.enrich.html | 2 +-
...e.streampipes.processors.filters.jvm.limit.html | 2 +-
...e.streampipes.processors.filters.jvm.merge.html | 2 +-
...pes.processors.filters.jvm.numericalfilter.html | 2 +-
...processors.filters.jvm.numericaltextfilter.html | 2 +-
...streampipes.processors.filters.jvm.project.html | 2 +-
...eampipes.processors.filters.jvm.textfilter.html | 2 +-
...reampipes.processors.filters.jvm.threshold.html | 2 +-
...ocessors.geo.jvm.jts.processor.latLngToGeo.html | 2 +-
...s.processors.geo.jvm.jts.processor.setEPSG.html | 2 +-
...rocessors.geo.jvm.jts.processor.trajectory.html | 2 +-
...ssors.geo.jvm.processor.distancecalculator.html | 2 +-
...ampipes.processors.geo.jvm.processor.speed.html | 2 +-
...geo.jvm.processor.staticdistancecalculator.html | 2 +-
...processors.pattern-detection.flink.absence.html | 2 +-
...pes.processors.pattern-detection.flink.and.html | 2 +-
...ors.pattern-detection.flink.peak-detection.html | 2 +-
...rocessors.pattern-detection.flink.sequence.html | 2 +-
...he.streampipes.processors.siddhi.frequency.html | 2 +-
...eampipes.processors.siddhi.frequencychange.html | 2 +-
...che.streampipes.processors.siddhi.increase.html | 2 +-
...eampipes.processors.siddhi.numericalfilter.html | 2 +-
...che.streampipes.processors.siddhi.sequence.html | 2 +-
....apache.streampipes.processors.siddhi.stop.html | 2 +-
...essors.statistics.flink.statistics-summary.html | 2 +-
...cessors.textmining.flink.languagedetection.html | 2 +-
...ipes.processors.textmining.flink.wordcount.html | 2 +-
...eampipes.processors.textmining.jvm.chunker.html | 2 +-
...rocessors.textmining.jvm.languagedetection.html | 2 +-
...pipes.processors.textmining.jvm.namefinder.html | 2 +-
...pes.processors.textmining.jvm.partofspeech.html | 2 +-
...rocessors.textmining.jvm.sentencedetection.html | 2 +-
...mpipes.processors.textmining.jvm.tokenizer.html | 2 +-
...ssors.transformation.flink.field-converter.html | 2 +-
...ocessors.transformation.flink.field-mapper.html | 2 +-
...cessors.transformation.flink.field-renamer.html | 2 +-
...rocessors.transformation.flink.fieldhasher.html | 2 +-
...formation.flink.measurement-unit-converter.html | 2 +-
...transformation.flink.processor.boilerplate.html | 2 +-
...rs.transformation.jvm.booloperator.counter.html | 2 +-
...s.transformation.jvm.booloperator.inverter.html | 2 +-
...ransformation.jvm.booloperator.timekeeping.html | 2 +-
...sors.transformation.jvm.booloperator.timer.html | 2 +-
...rocessors.transformation.jvm.changed-value.html | 2 +-
....processors.transformation.jvm.count-array.html | 2 +-
....processors.transformation.jvm.csvmetadata.html | 2 +-
...ocessors.transformation.jvm.duration-value.html | 2 +-
...sformation.jvm.processor.booloperator.edge.html | 2 +-
...formation.jvm.processor.booloperator.state.html | 2 +-
....transformation.jvm.processor.state.buffer.html | 2 +-
...rmation.jvm.processor.state.labeler.buffer.html | 2 +-
...rmation.jvm.processor.state.labeler.number.html | 2 +-
...rmation.jvm.processor.stringoperator.state.html | 2 +-
...formation.jvm.processor.timestampextractor.html | 2 +-
....processors.transformation.jvm.split-array.html | 2 +-
....transformation.jvm.stringoperator.counter.html | 2 +-
...rs.transformation.jvm.stringoperator.timer.html | 2 +-
...processors.transformation.jvm.taskduration.html | 2 +-
...rs.transformation.jvm.transform-to-boolean.html | 2 +-
.../org.apache.streampipes.protocol.set.file.html | 2 +-
.../org.apache.streampipes.protocol.set.http.html | 2 +-
...e.streampipes.sinks.brokers.jvm.bufferrest.html | 2 +-
...g.apache.streampipes.sinks.brokers.jvm.jms.html | 2 +-
...apache.streampipes.sinks.brokers.jvm.kafka.html | 2 +-
....apache.streampipes.sinks.brokers.jvm.nats.html | 2 +-
...pache.streampipes.sinks.brokers.jvm.pulsar.html | 2 +-
...che.streampipes.sinks.brokers.jvm.rabbitmq.html | 2 +-
....apache.streampipes.sinks.brokers.jvm.rest.html | 2 +-
...g.apache.streampipes.sinks.databases.ditto.html | 2 +-
...mpipes.sinks.databases.flink.elasticsearch.html | 2 +-
...he.streampipes.sinks.databases.jvm.couchdb.html | 2 +-
...e.streampipes.sinks.databases.jvm.influxdb.html | 2 +-
...ache.streampipes.sinks.databases.jvm.iotdb.html | 2 +-
...ache.streampipes.sinks.databases.jvm.mysql.html | 2 +-
...ache.streampipes.sinks.databases.jvm.opcua.html | 2 +-
...streampipes.sinks.databases.jvm.postgresql.html | 2 +-
...e.streampipes.sinks.internal.jvm.dashboard.html | 2 +-
...he.streampipes.sinks.internal.jvm.datalake.html | 2 +-
...treampipes.sinks.internal.jvm.notification.html | 2 +-
....streampipes.sinks.notifications.jvm.email.html | 2 +-
...eampipes.sinks.notifications.jvm.onesignal.html | 2 +-
....streampipes.sinks.notifications.jvm.slack.html | 2 +-
...reampipes.sinks.notifications.jvm.telegram.html | 2 +-
docs/docs/next/technicals-architecture.html | 2 +-
docs/docs/next/technicals-configuration.html | 2 +-
docs/docs/next/technicals-messaging.html | 2 +-
docs/docs/next/technicals-runtime-wrappers.html | 2 +-
docs/docs/next/technicals-user-guidance.html | 2 +-
docs/docs/next/try-installation.html | 26 +-
docs/docs/next/try-tutorial.html | 60 +-
docs/docs/next/use-configurations.html | 2 +-
docs/docs/next/use-connect.html | 8 +-
docs/docs/next/use-dashboard.html | 2 +-
docs/docs/next/use-data-explorer.html | 2 +-
docs/docs/next/use-install-pipeline-elements.html | 2 +-
docs/docs/next/use-managing-pipelines.html | 2 +-
docs/docs/next/use-notifications.html | 2 +-
docs/docs/next/use-pipeline-editor.html | 3 +-
docs/docs/next/user-guide-introduction.html | 8 +-
...org.apache.streampipes.processor.geo.flink.html | 4 +-
...he.streampipes.processor.geo.jvm.geocoding.html | 4 +-
...ampipes.processor.geo.jvm.reversegeocoding.html | 4 +-
...eampipes.processor.geo.jvm.staticgeocoding.html | 4 +-
...ification.jvm.generic-image-classification.html | 4 +-
...sor.imageclassification.jvm.image-enricher.html | 4 +-
...pipes.processor.imageclassification.qrcode.html | 4 +-
...s.processors.aggregation.flink.aggregation.html | 4 +-
...es.processors.aggregation.flink.eventcount.html | 4 +-
...eampipes.processors.aggregation.flink.rate.html | 4 +-
...ssors.enricher.flink.processor.math.mathop.html | 4 +-
...enricher.flink.processor.math.staticmathop.html | 4 +-
...sors.enricher.flink.processor.trigonometry.html | 4 +-
....enricher.flink.processor.urldereferencing.html | 4 +-
...mpipes.processors.enricher.flink.timestamp.html | 4 +-
...mpipes.processors.enricher.jvm.sizemeasure.html | 4 +-
...streampipes.processors.filters.jvm.compose.html | 4 +-
....streampipes.processors.filters.jvm.enrich.html | 4 +-
...e.streampipes.processors.filters.jvm.merge.html | 4 +-
...pes.processors.filters.jvm.numericalfilter.html | 4 +-
...processors.filters.jvm.numericaltextfilter.html | 4 +-
...streampipes.processors.filters.jvm.project.html | 4 +-
...eampipes.processors.filters.jvm.textfilter.html | 4 +-
...reampipes.processors.filters.jvm.threshold.html | 4 +-
...ssors.geo.jvm.processor.distancecalculator.html | 4 +-
...ors.pattern-detection.flink.peak-detection.html | 4 +-
...he.streampipes.processors.siddhi.frequency.html | 4 +-
...eampipes.processors.siddhi.frequencychange.html | 4 +-
...che.streampipes.processors.siddhi.increase.html | 4 +-
...eampipes.processors.siddhi.numericalfilter.html | 4 +-
...che.streampipes.processors.siddhi.sequence.html | 4 +-
....apache.streampipes.processors.siddhi.stop.html | 4 +-
...cessors.textmining.flink.languagedetection.html | 4 +-
...ipes.processors.textmining.flink.wordcount.html | 4 +-
...eampipes.processors.textmining.jvm.chunker.html | 4 +-
...rocessors.textmining.jvm.languagedetection.html | 4 +-
...pipes.processors.textmining.jvm.namefinder.html | 4 +-
...pes.processors.textmining.jvm.partofspeech.html | 4 +-
...rocessors.textmining.jvm.sentencedetection.html | 4 +-
...mpipes.processors.textmining.jvm.tokenizer.html | 4 +-
...ssors.transformation.flink.field-converter.html | 4 +-
...ocessors.transformation.flink.field-mapper.html | 4 +-
...cessors.transformation.flink.field-renamer.html | 4 +-
...rocessors.transformation.flink.fieldhasher.html | 4 +-
...formation.flink.measurement-unit-converter.html | 4 +-
...transformation.flink.processor.boilerplate.html | 4 +-
...rs.transformation.jvm.booloperator.counter.html | 4 +-
...s.transformation.jvm.booloperator.inverter.html | 4 +-
...ransformation.jvm.booloperator.timekeeping.html | 4 +-
...sors.transformation.jvm.booloperator.timer.html | 4 +-
...rocessors.transformation.jvm.changed-value.html | 4 +-
....processors.transformation.jvm.count-array.html | 4 +-
....processors.transformation.jvm.csvmetadata.html | 4 +-
...ocessors.transformation.jvm.duration-value.html | 4 +-
...formation.jvm.processor.timestampextractor.html | 4 +-
....processors.transformation.jvm.split-array.html | 4 +-
...processors.transformation.jvm.taskduration.html | 4 +-
...rs.transformation.jvm.transform-to-boolean.html | 4 +-
...e.streampipes.sinks.brokers.jvm.bufferrest.html | 4 +-
...g.apache.streampipes.sinks.brokers.jvm.jms.html | 4 +-
...apache.streampipes.sinks.brokers.jvm.kafka.html | 4 +-
...pache.streampipes.sinks.brokers.jvm.pulsar.html | 4 +-
...che.streampipes.sinks.brokers.jvm.rabbitmq.html | 4 +-
....apache.streampipes.sinks.brokers.jvm.rest.html | 4 +-
...g.apache.streampipes.sinks.databases.ditto.html | 4 +-
...mpipes.sinks.databases.flink.elasticsearch.html | 4 +-
...he.streampipes.sinks.databases.jvm.couchdb.html | 4 +-
...e.streampipes.sinks.databases.jvm.influxdb.html | 4 +-
...ache.streampipes.sinks.databases.jvm.iotdb.html | 4 +-
...ache.streampipes.sinks.databases.jvm.opcua.html | 4 +-
...streampipes.sinks.databases.jvm.postgresql.html | 4 +-
...e.streampipes.sinks.internal.jvm.dashboard.html | 4 +-
...he.streampipes.sinks.internal.jvm.datalake.html | 4 +-
...treampipes.sinks.internal.jvm.notification.html | 4 +-
....streampipes.sinks.notifications.jvm.email.html | 4 +-
...eampipes.sinks.notifications.jvm.onesignal.html | 4 +-
....streampipes.sinks.notifications.jvm.slack.html | 4 +-
...ache.streampipes.connect.adapters.coindesk.html | 4 +-
...che.streampipes.connect.adapters.flic.mqtt.html | 4 +-
....apache.streampipes.connect.adapters.gdelt.html | 4 +-
...ache.streampipes.connect.adapters.iex.news.html | 4 +-
...he.streampipes.connect.adapters.iex.stocks.html | 4 +-
...che.streampipes.connect.adapters.image.set.html | 4 +-
....streampipes.connect.adapters.image.stream.html | 4 +-
....streampipes.connect.adapters.influxdb.set.html | 4 +-
...reampipes.connect.adapters.influxdb.stream.html | 4 +-
...rg.apache.streampipes.connect.adapters.iss.html | 4 +-
...che.streampipes.connect.adapters.mysql.set.html | 4 +-
....streampipes.connect.adapters.mysql.stream.html | 4 +-
...he.streampipes.connect.adapters.netio.mqtt.html | 4 +-
...he.streampipes.connect.adapters.netio.rest.html | 4 +-
...onnect.adapters.nswaustralia.trafficcamera.html | 4 +-
....apache.streampipes.connect.adapters.opcua.html | 4 +-
....streampipes.connect.adapters.plc4x.modbus.html | 4 +-
...ache.streampipes.connect.adapters.plc4x.s7.html | 4 +-
...rg.apache.streampipes.connect.adapters.ros.html | 4 +-
...ampipes.connect.adapters.simulator.machine.html | 4 +-
...s.connect.adapters.simulator.randomdataset.html | 4 +-
...onnect.adapters.simulator.randomdatastream.html | 4 +-
....apache.streampipes.connect.adapters.slack.html | 4 +-
...org.apache.streampipes.connect.adapters.ti.html | 4 +-
...treampipes.connect.adapters.wikipedia.edit.html | 4 +-
...streampipes.connect.adapters.wikipedia.new.html | 4 +-
...e.streampipes.connect.protocol.stream.file.html | 4 +-
...e.streampipes.connect.protocol.stream.http.html | 4 +-
...ampipes.connect.protocol.stream.httpserver.html | 4 +-
....streampipes.connect.protocol.stream.kafka.html | 4 +-
...e.streampipes.connect.protocol.stream.mqtt.html | 4 +-
...streampipes.connect.protocol.stream.pulsar.html | 4 +-
...org.apache.streampipes.processor.geo.flink.html | 4 +-
...he.streampipes.processor.geo.jvm.geocoding.html | 4 +-
...ampipes.processor.geo.jvm.reversegeocoding.html | 4 +-
...eampipes.processor.geo.jvm.staticgeocoding.html | 4 +-
...ification.jvm.generic-image-classification.html | 4 +-
...ssor.imageclassification.jvm.image-cropper.html | 4 +-
...sor.imageclassification.jvm.image-enricher.html | 4 +-
...pipes.processor.imageclassification.qrcode.html | 4 +-
...s.processors.aggregation.flink.aggregation.html | 4 +-
...ampipes.processors.aggregation.flink.count.html | 4 +-
...es.processors.aggregation.flink.eventcount.html | 4 +-
...eampipes.processors.aggregation.flink.rate.html | 4 +-
...pipes.processors.changedetection.jvm.cusum.html | 4 +-
...ssors.enricher.flink.processor.math.mathop.html | 4 +-
...enricher.flink.processor.math.staticmathop.html | 4 +-
...sors.enricher.flink.processor.trigonometry.html | 4 +-
....enricher.flink.processor.urldereferencing.html | 4 +-
...mpipes.processors.enricher.flink.timestamp.html | 4 +-
...mpipes.processors.enricher.jvm.sizemeasure.html | 4 +-
...streampipes.processors.filters.jvm.compose.html | 4 +-
....streampipes.processors.filters.jvm.enrich.html | 4 +-
...e.streampipes.processors.filters.jvm.limit.html | 4 +-
...e.streampipes.processors.filters.jvm.merge.html | 4 +-
...pes.processors.filters.jvm.numericalfilter.html | 4 +-
...processors.filters.jvm.numericaltextfilter.html | 4 +-
...streampipes.processors.filters.jvm.project.html | 4 +-
...eampipes.processors.filters.jvm.textfilter.html | 4 +-
...reampipes.processors.filters.jvm.threshold.html | 4 +-
...ocessors.geo.jvm.jts.processor.latLngToGeo.html | 4 +-
...s.processors.geo.jvm.jts.processor.setEPSG.html | 4 +-
...rocessors.geo.jvm.jts.processor.trajectory.html | 4 +-
...ssors.geo.jvm.processor.distancecalculator.html | 4 +-
...ampipes.processors.geo.jvm.processor.speed.html | 4 +-
...geo.jvm.processor.staticdistancecalculator.html | 4 +-
...processors.pattern-detection.flink.absence.html | 4 +-
...pes.processors.pattern-detection.flink.and.html | 4 +-
...ors.pattern-detection.flink.peak-detection.html | 4 +-
...rocessors.pattern-detection.flink.sequence.html | 4 +-
...he.streampipes.processors.siddhi.frequency.html | 4 +-
...eampipes.processors.siddhi.frequencychange.html | 4 +-
...che.streampipes.processors.siddhi.increase.html | 4 +-
...eampipes.processors.siddhi.numericalfilter.html | 4 +-
...che.streampipes.processors.siddhi.sequence.html | 4 +-
....apache.streampipes.processors.siddhi.stop.html | 4 +-
...essors.statistics.flink.statistics-summary.html | 4 +-
...cessors.textmining.flink.languagedetection.html | 4 +-
...ipes.processors.textmining.flink.wordcount.html | 4 +-
...eampipes.processors.textmining.jvm.chunker.html | 4 +-
...rocessors.textmining.jvm.languagedetection.html | 4 +-
...pipes.processors.textmining.jvm.namefinder.html | 4 +-
...pes.processors.textmining.jvm.partofspeech.html | 4 +-
...rocessors.textmining.jvm.sentencedetection.html | 4 +-
...mpipes.processors.textmining.jvm.tokenizer.html | 4 +-
...ssors.transformation.flink.field-converter.html | 4 +-
...ocessors.transformation.flink.field-mapper.html | 4 +-
...cessors.transformation.flink.field-renamer.html | 4 +-
...rocessors.transformation.flink.fieldhasher.html | 4 +-
...formation.flink.measurement-unit-converter.html | 4 +-
...transformation.flink.processor.boilerplate.html | 4 +-
...rs.transformation.jvm.booloperator.counter.html | 4 +-
...s.transformation.jvm.booloperator.inverter.html | 4 +-
...ransformation.jvm.booloperator.timekeeping.html | 4 +-
...sors.transformation.jvm.booloperator.timer.html | 4 +-
...rocessors.transformation.jvm.changed-value.html | 4 +-
....processors.transformation.jvm.count-array.html | 4 +-
....processors.transformation.jvm.csvmetadata.html | 4 +-
...ocessors.transformation.jvm.duration-value.html | 4 +-
...sformation.jvm.processor.booloperator.edge.html | 4 +-
...formation.jvm.processor.booloperator.state.html | 4 +-
....transformation.jvm.processor.state.buffer.html | 4 +-
...rmation.jvm.processor.state.labeler.buffer.html | 4 +-
...rmation.jvm.processor.state.labeler.number.html | 4 +-
...rmation.jvm.processor.stringoperator.state.html | 4 +-
...formation.jvm.processor.timestampextractor.html | 4 +-
....processors.transformation.jvm.split-array.html | 4 +-
....transformation.jvm.stringoperator.counter.html | 4 +-
...rs.transformation.jvm.stringoperator.timer.html | 4 +-
...processors.transformation.jvm.taskduration.html | 4 +-
...rs.transformation.jvm.transform-to-boolean.html | 4 +-
.../org.apache.streampipes.protocol.set.file.html | 4 +-
.../org.apache.streampipes.protocol.set.http.html | 4 +-
...e.streampipes.sinks.brokers.jvm.bufferrest.html | 4 +-
...g.apache.streampipes.sinks.brokers.jvm.jms.html | 4 +-
...apache.streampipes.sinks.brokers.jvm.kafka.html | 4 +-
....apache.streampipes.sinks.brokers.jvm.mqtt.html | 4 +-
....apache.streampipes.sinks.brokers.jvm.nats.html | 4 +-
...pache.streampipes.sinks.brokers.jvm.pulsar.html | 4 +-
...che.streampipes.sinks.brokers.jvm.rabbitmq.html | 4 +-
....apache.streampipes.sinks.brokers.jvm.rest.html | 4 +-
...g.apache.streampipes.sinks.databases.ditto.html | 4 +-
...mpipes.sinks.databases.flink.elasticsearch.html | 4 +-
...he.streampipes.sinks.databases.jvm.couchdb.html | 4 +-
...e.streampipes.sinks.databases.jvm.influxdb.html | 4 +-
...ache.streampipes.sinks.databases.jvm.iotdb.html | 4 +-
...ache.streampipes.sinks.databases.jvm.mysql.html | 4 +-
...ache.streampipes.sinks.databases.jvm.opcua.html | 4 +-
...streampipes.sinks.databases.jvm.postgresql.html | 4 +-
...e.streampipes.sinks.internal.jvm.dashboard.html | 4 +-
...he.streampipes.sinks.internal.jvm.datalake.html | 4 +-
...treampipes.sinks.internal.jvm.notification.html | 4 +-
....streampipes.sinks.notifications.jvm.email.html | 4 +-
...eampipes.sinks.notifications.jvm.onesignal.html | 4 +-
....streampipes.sinks.notifications.jvm.slack.html | 4 +-
...reampipes.sinks.notifications.jvm.telegram.html | 4 +-
docs/docs/pipeline-elements.html | 2648 +++++++++++++++++++-
docs/docs/privacy.html | 4 +-
docs/docs/technicals-architecture.html | 4 +-
docs/docs/technicals-configuration.html | 64 +-
docs/docs/technicals-messaging.html | 6 +-
docs/docs/technicals-runtime-wrappers.html | 4 +-
docs/docs/technicals-user-guidance.html | 4 +-
docs/docs/try-installation.html | 134 +-
docs/docs/try-tutorial.html | 62 +-
docs/docs/use-configurations.html | 4 +-
docs/docs/use-connect.html | 10 +-
docs/docs/use-dashboard.html | 4 +-
docs/docs/use-data-explorer.html | 4 +-
docs/docs/use-install-pipeline-elements.html | 4 +-
docs/docs/use-managing-pipelines.html | 4 +-
docs/docs/use-notifications.html | 4 +-
docs/docs/use-pipeline-editor.html | 5 +-
docs/docs/user-guide-first-steps.html | 4 +-
docs/docs/user-guide-getting-started.html | 4 +-
docs/docs/user-guide-installation.html | 6 +-
docs/docs/user-guide-introduction-old.html | 4 +-
docs/docs/user-guide-introduction.html | 10 +-
docs/docs/user-guide-processing-elements.html | 4 +-
docs/docs/user-guide-software-components.html | 4 +-
docs/docs/user-guide-tour.html | 4 +-
docs/en/versions.html | 2 +-
docs/img/01_try-installation/03_login.png | Bin 38413 -> 29789 bytes
docs/img/01_try-installation/04_home.png | Bin 90544 -> 89273 bytes
.../01_try-overview/01_streampipes-overview.png | Bin 464113 -> 632696 bytes
docs/img/03_use-connect/01_connect-overview.png | Bin 102317 -> 92534 bytes
docs/img/03_use-connect/02_customize-format.png | Bin 60805 -> 75347 bytes
docs/img/03_use-connect/03_schema-editor.png | Bin 61444 -> 182642 bytes
.../03_use-connect/04_schema-editor-conversion.png | Bin 100546 -> 123613 bytes
docs/img/03_use-connect/05_adapter-generation.png | Bin 80891 -> 78001 bytes
docs/img/03_use-connect/06_connect-create.png | Bin 0 -> 110750 bytes
.../img/03_use-dashboard/01_dashboard-overview.png | Bin 36554 -> 31221 bytes
docs/img/03_use-dashboard/02_add-widget.png | Bin 82525 -> 95537 bytes
docs/img/03_use-dashboard/03_configure-widget.png | Bin 59148 -> 72624 bytes
docs/img/03_use-dashboard/04_live-dashboard.png | Bin 64078 -> 82830 bytes
.../01_data-explorer-overview.png | Bin 110898 -> 171834 bytes
.../01_pipeline-overview.png | Bin 44209 -> 42909 bytes
.../02_pipeline-start-dialog.png | Bin 74259 -> 53796 bytes
.../03_pipeline-details.png | Bin 99314 -> 84575 bytes
.../04_pipeline-quick-edit.png | Bin 86276 -> 87782 bytes
.../01_notifications-overview.png | Bin 54840 -> 43257 bytes
.../01_pipeline-editor-overview.png | Bin 65222 -> 99050 bytes
.../02_pipeline-element-info.png | Bin 88391 -> 125412 bytes
.../03_configure-pipeline-element.png | Bin 134080 -> 158013 bytes
.../03_use-pipeline-editor/06_save-pipeline.png | Bin 126247 -> 134019 bytes
docs/sitemap.xml | 2 +-
docs/versions.html | 2 +-
download.html | 8 +-
feature-overview.html | 2 +-
getinvolved.html | 2 +-
img/screenshots/sp-connect.png | Bin 468719 -> 408029 bytes
img/screenshots/sp-data-explorer-config.png | Bin 0 -> 407976 bytes
img/sp-logo-white-right.png | Bin 21453 -> 19196 bytes
index.html | 5 +-
mailinglists.html | 2 +-
media.html | 2 +-
meetus.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
.../documentation.html | 2 +-
pipeline-elements.html | 2 +-
team.html | 2 +-
technology.html | 2 +-
usecases.html | 2 +-
884 files changed, 35048 insertions(+), 2089 deletions(-)
diff --git a/docs/blog/2018/06/14/welcome.html b/docs/blog/2018/06/14/welcome.html
index 4f82b0ce..7fb055e1 100644
--- a/docs/blog/2018/06/14/welcome.html
+++ b/docs/blog/2018/06/14/welcome.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2018/06/18/how-to-understand-your-machine-data.html b/docs/blog/2018/06/18/how-to-understand-your-machine-data.html
index 2622c39d..5ef52bac 100644
--- a/docs/blog/2018/06/18/how-to-understand-your-machine-data.html
+++ b/docs/blog/2018/06/18/how-to-understand-your-machine-data.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2018/09/17/preview-060.html b/docs/blog/2018/09/17/preview-060.html
index 5acfd3a0..43b3f16b 100644
--- a/docs/blog/2018/09/17/preview-060.html
+++ b/docs/blog/2018/09/17/preview-060.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2018/11/24/container-cli.html b/docs/blog/2018/11/24/container-cli.html
index 29c471e8..8fc9568a 100644
--- a/docs/blog/2018/11/24/container-cli.html
+++ b/docs/blog/2018/11/24/container-cli.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2019/04/04/release-0610.html b/docs/blog/2019/04/04/release-0610.html
index 410368fa..6f894905 100644
--- a/docs/blog/2019/04/04/release-0610.html
+++ b/docs/blog/2019/04/04/release-0610.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2019/05/23/release-0620.html b/docs/blog/2019/05/23/release-0620.html
index 33f0c73f..095abf23 100644
--- a/docs/blog/2019/05/23/release-0620.html
+++ b/docs/blog/2019/05/23/release-0620.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2019/09/05/release-0630.html b/docs/blog/2019/09/05/release-0630.html
index a268625d..83b5be78 100644
--- a/docs/blog/2019/09/05/release-0630.html
+++ b/docs/blog/2019/09/05/release-0630.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2019/09/19/release-0640.html b/docs/blog/2019/09/19/release-0640.html
index 1892dddc..2334c32f 100644
--- a/docs/blog/2019/09/19/release-0640.html
+++ b/docs/blog/2019/09/19/release-0640.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2019/11/23/release-0650.html b/docs/blog/2019/11/23/release-0650.html
index 6b1b194a..1b09def4 100644
--- a/docs/blog/2019/11/23/release-0650.html
+++ b/docs/blog/2019/11/23/release-0650.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2019/11/25/moving-to-the-apache-incubator.html b/docs/blog/2019/11/25/moving-to-the-apache-incubator.html
index ebac867c..130c3018 100644
--- a/docs/blog/2019/11/25/moving-to-the-apache-incubator.html
+++ b/docs/blog/2019/11/25/moving-to-the-apache-incubator.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2020/01/23/streampipes_on_rpi.html b/docs/blog/2020/01/23/streampipes_on_rpi.html
index 1a3e163f..a83ae9b4 100644
--- a/docs/blog/2020/01/23/streampipes_on_rpi.html
+++ b/docs/blog/2020/01/23/streampipes_on_rpi.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2020/05/19/release-0660.html b/docs/blog/2020/05/19/release-0660.html
index 51e1d2c4..e8312471 100644
--- a/docs/blog/2020/05/19/release-0660.html
+++ b/docs/blog/2020/05/19/release-0660.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2020/05/27/streampipes_on_k3s.html b/docs/blog/2020/05/27/streampipes_on_k3s.html
index a413d005..50fd404a 100644
--- a/docs/blog/2020/05/27/streampipes_on_k3s.html
+++ b/docs/blog/2020/05/27/streampipes_on_k3s.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2021/07/22_release/0680.html b/docs/blog/2021/07/22_release/0680.html
index 1d692c44..780d0345 100644
--- a/docs/blog/2021/07/22_release/0680.html
+++ b/docs/blog/2021/07/22_release/0680.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2022/03/21_release/0690.html b/docs/blog/2022/03/21_release/0690.html
index 534ed04d..73a126ec 100644
--- a/docs/blog/2022/03/21_release/0690.html
+++ b/docs/blog/2022/03/21_release/0690.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2022/09/05/using-factory.io-with-streampipes.html b/docs/blog/2022/09/05/using-factory.io-with-streampipes.html
index c003c5ee..26131a87 100644
--- a/docs/blog/2022/09/05/using-factory.io-with-streampipes.html
+++ b/docs/blog/2022/09/05/using-factory.io-with-streampipes.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2022/10/13/release-070.html b/docs/blog/2022/10/13/release-070.html
index 8d7456ee..732172ad 100644
--- a/docs/blog/2022/10/13/release-070.html
+++ b/docs/blog/2022/10/13/release-070.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
diff --git a/docs/blog/2023/01/17/release-090.html b/docs/blog/2023/01/17/release-090.html
new file mode 100644
index 00000000..88893151
--- /dev/null
+++ b/docs/blog/2023/01/17/release-090.html
@@ -0,0 +1,162 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Apache StreamPipes release 0.90.0 · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="**<div style="float: left; padding-right: 40px;">5 minutes to read</div>**"/><meta name="docsearch:language" content="en"/><meta property [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer postContainer blogContainer"><div class="wrapper"><div class="lonePost"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle"><a href="/docs/blog/2023/01/17/release-090.html">Apache StreamPipes release 0.90.0</a></h1><p class="post-meta">January 17, 2023</p><div class="authorBlock"><p class="post-authorName"><a href="https://github.com/dominikriemer" target="_blank" rel="noreferrer noopener">Dominik Rieme [...]
+<br></p>
+<p>The Apache StreamPipes community is pleased to announce the immediate availability of Apache StreamPipes version 0.90.0!
+In total, this release was focused on stabilization and closes 57 issues with improvements and bug fixes as well as some new features such as adapters and data sinks.</p>
+<!--truncate-->
+<p>The current release can be downloaded <a href="https://streampipes.apache.org/download.html">here</a>.</p>
+<h2><a class="anchor" aria-hidden="true" id="improvements"></a><a href="#improvements" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83. [...]
+<p>The focus of this release cycle was on general usability improvements and bug fixes. We continued to harmonize the
+StreamPipes web interface, so that all views follow a similar navigation. Many improvements were added to the data explorer:</p>
+<ul>
+<li>Incomplete events with missing values are now displayed in the data explorer</li>
+<li>Improvements to the time selector and edit mode</li>
+<li>More configuration options for data download</li>
+<li>Improved overall data explorer performance</li>
+</ul>
+<p>In addition, we improved features to monitor pipelines and extensions services. The pipeline monitoring component has been restructured and now works independent from the underlying message broker.
+In addition, we extended the SDK so that runtime errors can be forwarded to the StreamPipes UI.
+Further improvements to the monitoring stack will be added in the next versions.</p>
+<h2><a class="anchor" aria-hidden="true" id="new-adapters-and-data-sinks"></a><a href="#new-adapters-and-data-sinks" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 1 [...]
+<p>This version improves support for existing message brokers in form of adapters and sinks:</p>
+<ul>
+<li>Improvements of the <code>Apache Pulsar</code> (which is also available as a data sink)</li>
+<li>A new adapter and data sink for <code>Apache RocketMQ</code></li>
+<li>A new adapter for <code>NATS</code> (also available as a data sink)</li>
+</ul>
+<h2><a class="anchor" aria-hidden="true" id="github-community-features"></a><a href="#github-community-features" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c [...]
+<p>Apache StreamPipes is a community effort - everyone is welcome not only to contribute code, but also to provide feedback and other input which helps improving the product.
+To improve community interaction, we switched our issue management from Jira to GitHub issues - making it much easier to create issues and to discuss future features.
+In addition, we've enabled Github Discussions - feel free to participate in the existing discussions and ask questions if you have problems!</p>
+<ul>
+<li><a href="https://github.com/apache/streampipes/issues">GitHub Issues</a></li>
+<li><a href="https://github.com/apache/streampipes/discussions">GitHub Discussions</a></li>
+</ul>
+<p>And if you prefer the mailing list, subscribe to <a href="mailto:dev-subscribe@streampipes.apache.org">dev@streampipes.apache.org</a> or <a href="mailto:users-subscribe@streampipes.apache.org">users@streampipes.apache.org</a>.
+Tech-related and general project discussions as well as release votes will continue to happen on the dev list.</p>
+<p><img src="/docs/blog/assets/2023-01-17/github-discussions.png" alt="Github Discussions overview"></p>
+<h2><a class="anchor" aria-hidden="true" id="preview-of-standalone-functions"></a><a href="#preview-of-standalone-functions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 [...]
+<p>An exciting new feature is available in preview mode: StreamPipes Functions are a new way to interact with connected data streams in StreamPipes.
+As an open system, there are already several ways to extend the functionality of StreamPipes: New adapter can be added to connect to non-supported systems.
+In addition, the SDK supports building custom data processors and sinks, so that StreamPipes can be easily extended at runtime in case new analytics operators are needed.</p>
+<p>But providing extensions in form of pipeline elements are not always the best choice: E.g., in cases where non-generic algorithms should be executed on a specific data stream,
+providing a reusable component for pipeline development is unsuitable.</p>
+<p>This is where Functions come into play! StreamPipes Functions allow to define standalone components, which consume one or more connected data streams from StreamPipes and can be used to add custom processing logic.
+E.g., it becomes easy to apply an ML model on continuous data without the need to build a specific data processing pipeline.</p>
+<p>Functions can be registered in an extensions service similar to data processors and sinks by extending a single class:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyFunction</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">StreamPipesFunction</span> </span>{
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> FunctionId <span class="hljs-title">getFunctionId</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> FunctionId.from(<span class="hljs-string">"my-app-id"</span>, <span class="hljs-number">1</span>);
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> List<String> <span class="hljs-title">requiredStreamIds</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> List.of(<span class="hljs-string">"my-stream-id"</span>);
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onServiceStarted</span><span class="hljs-params">(FunctionContext context)</span> </span>{
+ <span class="hljs-comment">// called on service startup</span>
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event, String streamId)</span> </span>{
+ <span class="hljs-comment">// called for each incoming event</span>
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onServiceStopped</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-comment">// called on service shutdown</span>
+ }
+}
+</code></pre>
+<p>This concept, which will also come for more programming languages besides Java offer new ways for developers to interact with available data in StreamPipes and build custom extensions for IIoT analytics.</p>
+<p>Functions are available in preview mode and their API should therefore be considered unstable.</p>
+<h2><a class="anchor" aria-hidden="true" id="future-roadmap"></a><a href="#future-roadmap" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>After this stabilization release, the next version will most probably bring a major new feature - Python support!
+The community is currently working hard to bring the StreamPipes client and functions to the Python world. Stay tuned!</p>
+<p><br>
+To get a comprehensive overview of all changes released within Apache StreamPipes 0.90.0
+please visit our <a href="https://github.com/apache/incubator-streampipes/blob/release/0.90.0/RELEASE_NOTES.md#0900">release notes</a>.</p>
+</span></div></div><div class="blogSocialSection"></div></div><div class="blog-recent"><a class="button" href="/docs/blog/">Recent Posts</a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#improvements">Improvements</a></li><li><a href="#new-adapters-and-data-sinks">New Adapters and Data Sinks</a></li><li><a href="#github-community-features">GitHub Community Features</a></li><li><a href="#preview-of-standalone-functions">Preview of Standalone Functions</a>< [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/blog/assets/2023-01-17/github-discussions.png b/docs/blog/assets/2023-01-17/github-discussions.png
new file mode 100644
index 00000000..d9387b36
Binary files /dev/null and b/docs/blog/assets/2023-01-17/github-discussions.png differ
diff --git a/docs/blog/atom.xml b/docs/blog/atom.xml
index ffbb09c9..cf7af584 100644
--- a/docs/blog/atom.xml
+++ b/docs/blog/atom.xml
@@ -2,12 +2,27 @@
<feed xmlns="http://www.w3.org/2005/Atom">
<id>https://streampipes.apache.org/docs/blog</id>
<title>Apache StreamPipes Blog</title>
- <updated>2022-10-13T06:00:00.000Z</updated>
+ <updated>2023-01-17T06:00:00.000Z</updated>
<generator>https://github.com/jpmonette/feed</generator>
<link rel="alternate" href="https://streampipes.apache.org/docs/blog"/>
<subtitle>The best place to stay up-to-date with the latest Apache StreamPipes news and events.</subtitle>
<logo>https://streampipes.apache.org/docs/img/sp-logo-color-docs.png</logo>
<rights>Copyright © 2019 - 2023 The Apache Software Foundation</rights>
+ <entry>
+ <title type="html"><![CDATA[Apache StreamPipes release 0.90.0]]></title>
+ <id>https://streampipes.apache.org/docs/blog/2023/01/17/release-090.html</id>
+ <link href="https://streampipes.apache.org/docs/blog/2023/01/17/release-090.html"/>
+ <updated>2023-01-17T06:00:00.000Z</updated>
+ <summary type="html"><![CDATA[<p><strong><div style="float: left; padding-right: 40px;">5 minutes to read</div></strong>
+<br></p>
+<p>The Apache StreamPipes community is pleased to announce the immediate availability of Apache StreamPipes version 0.90.0!
+In total, this release was focused on stabilization and closes 57 issues with improvements and bug fixes as well as some new features such as adapters and data sinks.</p>
+]]></summary>
+ <author>
+ <name>Dominik Riemer</name>
+ <uri>https://github.com/dominikriemer</uri>
+ </author>
+ </entry>
<entry>
<title type="html"><![CDATA[Apache StreamPipes release 0.70.0]]></title>
<id>https://streampipes.apache.org/docs/blog/2022/10/13/release-070.html</id>
diff --git a/docs/blog/feed.xml b/docs/blog/feed.xml
index 2f422660..16d12efd 100644
--- a/docs/blog/feed.xml
+++ b/docs/blog/feed.xml
@@ -4,7 +4,7 @@
<title>Apache StreamPipes Blog</title>
<link>https://streampipes.apache.org/docs/blog</link>
<description>The best place to stay up-to-date with the latest Apache StreamPipes news and events.</description>
- <lastBuildDate>Thu, 13 Oct 2022 06:00:00 GMT</lastBuildDate>
+ <lastBuildDate>Tue, 17 Jan 2023 06:00:00 GMT</lastBuildDate>
<docs>https://validator.w3.org/feed/docs/rss2.html</docs>
<generator>https://github.com/jpmonette/feed</generator>
<image>
@@ -13,6 +13,17 @@
<link>https://streampipes.apache.org/docs/blog</link>
</image>
<copyright>Copyright © 2019 - 2023 The Apache Software Foundation</copyright>
+ <item>
+ <title><![CDATA[Apache StreamPipes release 0.90.0]]></title>
+ <link>https://streampipes.apache.org/docs/blog/2023/01/17/release-090.html</link>
+ <guid>https://streampipes.apache.org/docs/blog/2023/01/17/release-090.html</guid>
+ <pubDate>Tue, 17 Jan 2023 06:00:00 GMT</pubDate>
+ <description><![CDATA[<p><strong><div style="float: left; padding-right: 40px;">5 minutes to read</div></strong>
+<br></p>
+<p>The Apache StreamPipes community is pleased to announce the immediate availability of Apache StreamPipes version 0.90.0!
+In total, this release was focused on stabilization and closes 57 issues with improvements and bug fixes as well as some new features such as adapters and data sinks.</p>
+]]></description>
+ </item>
<item>
<title><![CDATA[Apache StreamPipes release 0.70.0]]></title>
<link>https://streampipes.apache.org/docs/blog/2022/10/13/release-070.html</link>
diff --git a/docs/blog/index.html b/docs/blog/index.html
index c06bd0f0..df8efb3d 100644
--- a/docs/blog/index.html
+++ b/docs/blog/index.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="blog"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a><div class="navigationWrapper [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="blog"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a><div class="navigationWrapper [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
@@ -60,7 +60,11 @@
};
}
});
- </script></nav></div><div class="container mainContainer postContainer blogContainer"><div class="wrapper"><div class="posts"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle"><a href="/docs/blog/2022/10/13/release-070.html">Apache StreamPipes release 0.70.0</a></h1><p class="post-meta">October 13, 2022</p><div class="authorBlock"><p class="post-authorName"><a href="https://github.com/bossenti" target="_blank" rel="noreferrer noopener">Tim Bossenmaier</a></ [...]
+ </script></nav></div><div class="container mainContainer postContainer blogContainer"><div class="wrapper"><div class="posts"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle"><a href="/docs/blog/2023/01/17/release-090.html">Apache StreamPipes release 0.90.0</a></h1><p class="post-meta">January 17, 2023</p><div class="authorBlock"><p class="post-authorName"><a href="https://github.com/dominikriemer" target="_blank" rel="noreferrer noopener">Dominik Riemer</ [...]
+<br></p>
+<p>The Apache StreamPipes community is pleased to announce the immediate availability of Apache StreamPipes version 0.90.0!
+In total, this release was focused on stabilization and closes 57 issues with improvements and bug fixes as well as some new features such as adapters and data sinks.</p>
+</span></div><div class="read-more"><a class="button" href="/docs/blog/2023/01/17/release-090.html">Read More</a></div></article></div><div class="post"><header class="postHeader"><h1 class="postHeaderTitle"><a href="/docs/blog/2022/10/13/release-070.html">Apache StreamPipes release 0.70.0</a></h1><p class="post-meta">October 13, 2022</p><div class="authorBlock"><p class="post-authorName"><a href="https://github.com/bossenti" target="_blank" rel="noreferrer noopener">Tim Bossenmaier</a>< [...]
<br></p>
<p>The Apache StreamPipes (incubating) community is delighted to announce the release of Apache StreamPipes version 0.70.0!
Key highlights of this release include many enhancements to the data explorer for fast exploration of IoT data and
@@ -96,11 +100,7 @@ Great news: StreamPipes is moving to the Apache Incubator!</p>
</span></div><div class="read-more"><a class="button" href="/docs/blog/2019/11/25/moving-to-the-apache-incubator.html">Read More</a></div></article></div><div class="post"><header class="postHeader"><h1 class="postHeaderTitle"><a href="/docs/blog/2019/11/23/release-0650.html">StreamPipes release 0.65.0</a></h1><p class="post-meta">November 23, 2019</p><div class="authorBlock"><p class="post-authorName"><a href="https://twitter.com/dominikjriemer" target="_blank" rel="noreferrer noopener" [...]
<br></p>
<p>We are happy to announce StreamPipes version 0.65.0! This release brings performance improvements related to the installation process and further reduces the minimum hardware requirements to run StreamPipes.</p>
-</span></div><div class="read-more"><a class="button" href="/docs/blog/2019/11/23/release-0650.html">Read More</a></div></article></div><div class="post"><header class="postHeader"><h1 class="postHeaderTitle"><a href="/docs/blog/2019/09/19/release-0640.html">StreamPipes release 0.64.0</a></h1><p class="post-meta">September 19, 2019</p><div class="authorBlock"><p class="post-authorName"><a href="https://twitter.com/dominikjriemer" target="_blank" rel="noreferrer noopener">Dominik Riemer</ [...]
-<br></p>
-<p>Usually, we try to publish a new StreamPipes release every three months. But after attending a very exciting <a href="https://www.apachecon.com/acna19/">ApacheCon</a> last week, where we worked with some Apache communities on a few really cool new features, we decided to release these features as soon as possible.
-So here's StreamPipes 0.64.0!</p>
-</span></div><div class="read-more"><a class="button" href="/docs/blog/2019/09/19/release-0640.html">Read More</a></div></article></div><div class="docs-prevnext"><a class="docs-next" href="/docs/blog/page2/">Next →</a></div></div></div></div></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes" width="66"/></a><div><h5>Docs</h5><a href="/docs/docs/user-guide-introductio [...]
+</span></div><div class="read-more"><a class="button" href="/docs/blog/2019/11/23/release-0650.html">Read More</a></div></article></div><div class="docs-prevnext"><a class="docs-next" href="/docs/blog/page2/">Next →</a></div></div></div></div></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes" width="66"/></a><div><h5>Docs</h5><a href="/docs/docs/user-guide-introductio [...]
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;
diff --git a/docs/blog/page2/index.html b/docs/blog/page2/index.html
index 7e30451f..ba8b2d80 100644
--- a/docs/blog/page2/index.html
+++ b/docs/blog/page2/index.html
@@ -4,7 +4,7 @@
{"zIndex":100}
)
});
- </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="blog"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a><div class="navigationWrapper [...]
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="blog"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.90.0</h3></a><div class="navigationWrapper [...]
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
@@ -60,7 +60,11 @@
};
}
});
- </script></nav></div><div class="container mainContainer postContainer blogContainer"><div class="wrapper"><div class="posts"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle"><a href="/docs/blog/2019/09/05/release-0630.html">StreamPipes release 0.63.0</a></h1><p class="post-meta">September 5, 2019</p><div class="authorBlock"><p class="post-authorName"><a href="https://twitter.com/dominikjriemer" target="_blank" rel="noreferrer noopener">Dominik Riemer</a>< [...]
+ </script></nav></div><div class="container mainContainer postContainer blogContainer"><div class="wrapper"><div class="posts"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle"><a href="/docs/blog/2019/09/19/release-0640.html">StreamPipes release 0.64.0</a></h1><p class="post-meta">September 19, 2019</p><div class="authorBlock"><p class="post-authorName"><a href="https://twitter.com/dominikjriemer" target="_blank" rel="noreferrer noopener">Dominik Riemer</a> [...]
+<br></p>
+<p>Usually, we try to publish a new StreamPipes release every three months. But after attending a very exciting <a href="https://www.apachecon.com/acna19/">ApacheCon</a> last week, where we worked with some Apache communities on a few really cool new features, we decided to release these features as soon as possible.
+So here's StreamPipes 0.64.0!</p>
+</span></div><div class="read-more"><a class="button" href="/docs/blog/2019/09/19/release-0640.html">Read More</a></div></article></div><div class="post"><header class="postHeader"><h1 class="postHeaderTitle"><a href="/docs/blog/2019/09/05/release-0630.html">StreamPipes release 0.63.0</a></h1><p class="post-meta">September 5, 2019</p><div class="authorBlock"><p class="post-authorName"><a href="https://twitter.com/dominikjriemer" target="_blank" rel="noreferrer noopener">Dominik Riemer</a [...]
<br></p>
<p>StreamPipes version 0.63.0 has been released! Following our release plan to alternate between user-faced and backend-oriented releases, this release contains many (more than 70) features and improvements, mainly on the backend side.
The new version is available on Docker Hub and can be downloaded using our <a href="https://github.com/apache/incubator-streampipes-installer">installer</a>.</p>
diff --git a/docs/css/main.css b/docs/css/main.css
index 865fe26a..796370b0 100644
--- a/docs/css/main.css
+++ b/docs/css/main.css
@@ -4,4 +4,4 @@
* Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com
* License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
* Copyright 2022 Fonticons, Inc.
- */.fa{font-family:var(--fa-style-family,"Font Awesome 6 Free");font-weight:var(--fa-style,900)}.fa,.fa-brands,.fa-classic,.fa-regular,.fa-sharp,.fa-solid,.fab,.far,.fas{-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased;display:var(--fa-display,inline-block);font-style:normal;font-variant:normal;line-height:1;text-rendering:auto}.fa-classic,.fa-regular,.fa-solid,.far,.fas{font-family:Font Awesome\ 6 Free}.fa-brands,.fab{font-family:Font Awesome\ 6 Brands}.fa-1x{font-si [...]
\ No newline at end of file
+ */.fa{font-family:var(--fa-style-family,"Font Awesome 6 Free");font-weight:var(--fa-style,900)}.fa,.fa-brands,.fa-classic,.fa-regular,.fa-sharp,.fa-solid,.fab,.far,.fas{-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased;display:var(--fa-display,inline-block);font-style:normal;font-variant:normal;line-height:1;text-rendering:auto}.fa-classic,.fa-regular,.fa-solid,.far,.fas{font-family:Font Awesome\ 6 Free}.fa-brands,.fab{font-family:Font Awesome\ 6 Brands}.fa-1x{font-si [...]
\ No newline at end of file
diff --git a/docs/docs/0.70.0/community-contribute.html b/docs/docs/0.70.0/community-contribute.html
new file mode 100644
index 00000000..6bbeeff7
--- /dev/null
+++ b/docs/docs/0.70.0/community-contribute.html
@@ -0,0 +1,93 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Contribute · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Contribute"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Contribute · Apache StreamPipes"/><m [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Contribute</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="contribute"></a><a href="#contribute" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 [...]
+<p>We welcome contributions to StreamPipes. If you are interested in contributing to StreamPipes, let us know! You'll
+get to know an open-minded and motivated team working together to build the next IIoT analytics toolbox.</p>
+<p>Here are some first steps in case you want to contribute:</p>
+<ul>
+<li>Subscribe to our dev mailing list <a href="dev-subscribe@streampipes.apache.org">dev-subscribe@streampipes.apache.org</a></li>
+<li>Send an email, tell us about your interests and which parts of Streampipes you'd like to contribute (e.g., core or UI)!</li>
+<li>Ask for a mentor who helps you understanding the code base and guides you through the first setup steps</li>
+<li>Find an issue in our <a href="https://issues.apache.org/jira/projects/STREAMPIPES">Jira</a> which is tagged with a <em>newbie</em> tag</li>
+<li>Have a look at our <strong>developer wiki</strong> at <a href="https://cwiki.apache.org/confluence/display/STREAMPIPES">https://cwiki.apache.org/confluence/display/STREAMPIPES</a> to learn more about StreamPipes development.</li>
+</ul>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/community-get-help.html"><span class="arrow-prev">← </span><span>Get Help</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#contribute">Contribute</a></li></ul></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes" width [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/community-get-help.html b/docs/docs/0.70.0/community-get-help.html
new file mode 100644
index 00000000..a5d84f35
--- /dev/null
+++ b/docs/docs/0.70.0/community-get-help.html
@@ -0,0 +1,92 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Get Help · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="The Apache StreamPipes community is happy to help with any questions or problems you might have."/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" cont [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Get Help</h1></header><article><div><span><p>The Apache StreamPipes community is happy to help with any questions or problems you might have.</p>
+<h2><a class="anchor" aria-hidden="true" id="questions"></a><a href="#questions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>Subscribe to our user mailing list to ask a question.</p>
+<p><a href="https://streampipes.apache.org/mailinglists.html">Mailing Lists</a></p>
+<p>To subscribe to the user list, send an email to <a href="users-subscribe@streampipes.apache.org">users-subscribe@streampipes.apache.org</a></p>
+<p>You can also ask questions on our Github discussions page:
+<a href="https://github.com/apache/streampipes/discussions">Github Discussions</a></p>
+<h2><a class="anchor" aria-hidden="true" id="bugs-and-feature-requests"></a><a href="#bugs-and-feature-requests" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c [...]
+<p>If you've found a bug or have a feature that you'd love to see in StreamPipes, feel free to create an issue on <a href="https://github.com/apache/streampipes/issues">GitHub</a>
+or <a href="https://github.com/apache/streampipes/discussions/categories/ideas">discuss your ideas</a>.</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/technical-configuration.html"><span class="arrow-prev">← </span><span>Previous</span></a><a class="docs-next button" href="/docs/docs/0.70.0/community-contribute.html"><span>Contribute</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#questions">Questions</a></li><li><a href="#bugs-and-feature-requests">Bugs [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/concepts-adapter.html b/docs/docs/0.70.0/concepts-adapter.html
new file mode 100644
index 00000000..b92422fa
--- /dev/null
+++ b/docs/docs/0.70.0/concepts-adapter.html
@@ -0,0 +1,27 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Data Adapters · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="tbd"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Data Adapters · Apache StreamPipes"/><meta [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes" width="66"/></a><div><h5>Docs</h5><a href="/docs/docs/user-guide-introduction">User Guide</a><a href="/docs/docs/dev-guide-introduction">Developer Guide</a><a href="/docs/docs/faq-common-problems">Frequently Asked Qu [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/concepts-data-streams.html b/docs/docs/0.70.0/concepts-data-streams.html
new file mode 100644
index 00000000..f7ebe36c
--- /dev/null
+++ b/docs/docs/0.70.0/concepts-data-streams.html
@@ -0,0 +1,27 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Data Streams · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="tbd"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Data Streams · Apache StreamPipes"/><meta pr [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes" width="66"/></a><div><h5>Docs</h5><a href="/docs/docs/user-guide-introduction">User Guide</a><a href="/docs/docs/dev-guide-introduction">Developer Guide</a><a href="/docs/docs/faq-common-problems">Frequently Asked Qu [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/concepts-glossary.html b/docs/docs/0.70.0/concepts-glossary.html
new file mode 100644
index 00000000..1f7bdc58
--- /dev/null
+++ b/docs/docs/0.70.0/concepts-glossary.html
@@ -0,0 +1,27 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Glossary · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="tbd"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Glossary · Apache StreamPipes"/><meta property=" [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes" width="66"/></a><div><h5>Docs</h5><a href="/docs/docs/user-guide-introduction">User Guide</a><a href="/docs/docs/dev-guide-introduction">Developer Guide</a><a href="/docs/docs/faq-common-problems">Frequently Asked Qu [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/concepts-overview.html b/docs/docs/0.70.0/concepts-overview.html
new file mode 100644
index 00000000..579ab728
--- /dev/null
+++ b/docs/docs/0.70.0/concepts-overview.html
@@ -0,0 +1,105 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>StreamPipes Concepts · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="To understand how StreamPipes works, the knowledge of a few core concepts, illustrated below, will be helpful."/><meta name="docsearch:version" content="0.70.0"/><meta name [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">StreamPipes Concepts</h1></header><article><div><span><p>To understand how StreamPipes works, the knowledge of a few core concepts, illustrated below, will be helpful.</p>
+<p><img class="docs-image" src="/docs/img/02_concepts-overview/01_overview.png" alt="Overview of concepts"></p>
+<h2><a class="anchor" aria-hidden="true" id="adapter"></a><a href="#adapter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1- [...]
+<p>An adapter connects to any external data source and forwards received events to the internal StreamPipes system. Within StreamPipes, the output of adapters are available in form of the two primary building blocks <strong>Data Set</strong> and <strong>Data Stream</strong>.
+Adapters can be either created by using StreamPipes Connect, a module to easily connect to new data sources directly from the user interface, or by defining an adapter using the provided Software Development Kit (SDK).</p>
+<h2><a class="anchor" aria-hidden="true" id="data-set--data-stream"></a><a href="#data-set--data-stream" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2 [...]
+<p><strong>Data Streams</strong> and <strong>Data Sets</strong> represent the primary source for working with events in StreamPipes.
+A stream is an ordered sequence of events, where an event typically consists of one or more observation values and additional metadata. The "structure" (or schema) of an event provided by a data stream or set is stored in the internal semantic schema registry of StreamPipes.
+While data streams are typically unbounded, data sets have a fixed end and are internally "replayed" by the system from beginning to end once they are used as part of a pipeline.
+As follows, although when referring to data streams, most concepts also apply for data sets.</p>
+<h2><a class="anchor" aria-hidden="true" id="data-processor"></a><a href="#data-processor" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p><strong>Data Processors</strong> in StreamPipes transform one or more input data streams into an output data stream.
+Such transformations can be rather simple, e.g. filtering based on a predefined rule or more complex, e.g. applying rule-based or learning-based algorithms on the data.<br>
+Data Processors can be applied on any data stream that matches the input requirements of a processor. In addition, most processors can be configured by providing user-defined parameters directly in the user interface.
+Processing elements define stream requirements that are a set of minimum properties an incoming event stream must provide. Data processors can keep state or perform stateless operations.
+At runtime, data streams are processed by using one of the underlying runtime wrappers (see the developer guide for more details).</p>
+<h2><a class="anchor" aria-hidden="true" id="data-sink"></a><a href="#data-sink" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p><strong>Data Sinks</strong> consume event streams similar to Data Processors, but do not provide an output data stream. As such, data sinks typically perform some action or trigger a visualization as a result of a stream transformation.
+Similar to data processors, sinks also require for the presence of specific input requirements of any bound data stream and can be customized.
+StreamPipes provides several internal data sinks, e.g., to create notifications, visualize live data or persist historical data of incoming streams. In addition, various data sinks are provided to forward data streams to external systems such as databases.</p>
+<h2><a class="anchor" aria-hidden="true" id="pipeline"></a><a href="#pipeline" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 [...]
+<p>A pipeline in Apache StreamPipes describes the transformation process from a data stream to a data sink. Typically, a pipeline consists of at least one data stream (or data set), zero or more data processors and at least one data sink.
+Pipelines are built by users in a graphical way using the <strong>Pipeline Editor</strong> and can be started and stopped at any time.</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/try-tutorial.html"><span class="arrow-prev">← </span><span>Interactive Tutorial</span></a><a class="docs-next button" href="/docs/docs/0.70.0/use-connect.html"><span class="function-name-prevnext">StreamPipes Connect</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#adapter">Adapter</a></li><li><a href="#data [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/concepts-pipelines.html b/docs/docs/0.70.0/concepts-pipelines.html
new file mode 100644
index 00000000..d5d77abe
--- /dev/null
+++ b/docs/docs/0.70.0/concepts-pipelines.html
@@ -0,0 +1,27 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Pipelines · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="tbd"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Pipelines · Apache StreamPipes"/><meta property [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes" width="66"/></a><div><h5>Docs</h5><a href="/docs/docs/user-guide-introduction">User Guide</a><a href="/docs/docs/dev-guide-introduction">Developer Guide</a><a href="/docs/docs/faq-common-problems">Frequently Asked Qu [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/debugging-debugging.html b/docs/docs/0.70.0/debugging-debugging.html
new file mode 100644
index 00000000..b4fb400e
--- /dev/null
+++ b/docs/docs/0.70.0/debugging-debugging.html
@@ -0,0 +1,27 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Debugging · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="tbd"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Debugging · Apache StreamPipes"/><meta property [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes" width="66"/></a><div><h5>Docs</h5><a href="/docs/docs/user-guide-introduction">User Guide</a><a href="/docs/docs/dev-guide-introduction">Developer Guide</a><a href="/docs/docs/faq-common-problems">Frequently Asked Qu [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/debugging-monitoring.html b/docs/docs/0.70.0/debugging-monitoring.html
new file mode 100644
index 00000000..fb58e7c2
--- /dev/null
+++ b/docs/docs/0.70.0/debugging-monitoring.html
@@ -0,0 +1,27 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Monitoring · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="tbd"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Monitoring · Apache StreamPipes"/><meta proper [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes" width="66"/></a><div><h5>Docs</h5><a href="/docs/docs/user-guide-introduction">User Guide</a><a href="/docs/docs/dev-guide-introduction">Developer Guide</a><a href="/docs/docs/faq-common-problems">Frequently Asked Qu [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/deploy-docker.html b/docs/docs/0.70.0/deploy-docker.html
new file mode 100644
index 00000000..df0e329e
--- /dev/null
+++ b/docs/docs/0.70.0/deploy-docker.html
@@ -0,0 +1,138 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Docker Deployment · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="StreamPipes Compose is a simple collection of user-friendly `docker-compose` files that easily lets gain first-hand experience with Apache StreamPipes."/><meta name="docsearch [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Docker Deployment</h1></header><article><div><span><p>StreamPipes Compose is a simple collection of user-friendly <code>docker-compose</code> files that easily lets gain first-hand experience with Apache StreamPipes.</p>
+<blockquote>
+<p><strong>NOTE</strong>: We recommend StreamPipes Compose to only use for initial try-out and testing. If you are a developer and
+want to develop new pipeline elements or core feature, use the <a href="/docs/docs/0.70.0/extend-cli.html">StreamPipes CLI</a>.</p>
+</blockquote>
+<h4><a class="anchor" aria-hidden="true" id="tldr-a-one-liner-to-rule-them-all--"></a><a href="#tldr-a-one-liner-to-rule-them-all--" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2 [...]
+<pre><code class="hljs css language-bash">docker-compose up -d
+</code></pre>
+<p>Go to <a href="http://localhost">http://localhost</a> to finish the installation in the browser. Once finished, switch to the pipeline editor and start the interactive tour or check the <a href="https://streampipes.apache.org/docs/docs/user-guide-tour/">online tour</a> to learn how to create your first pipeline!</p>
+<h2><a class="anchor" aria-hidden="true" id="prerequisites"></a><a href="#prerequisites" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<ul>
+<li>Docker >= 17.06.0</li>
+<li>Docker-Compose >= 1.17.0 (Compose file format: 3.4)</li>
+<li>Google Chrome (recommended), Mozilla Firefox, Microsoft Edge</li>
+</ul>
+<p>Tested on: <strong>macOS, Linux, Windows 10</strong> (CMD, PowerShell, GitBash)</p>
+<p><strong>macOS</strong> and <strong>Windows 10</strong> (Pro, Enterprise, Education) users can easily get Docker and Docker-Compose on their systems by installing <strong>Docker for Mac/Windows</strong> (recommended).</p>
+<blockquote>
+<p><strong>NOTE</strong>: On purpose, we disabled all port mappings except of http port <strong>80</strong> to access the StreamPipes UI to provide minimal surface for conflicting ports.</p>
+</blockquote>
+<h2><a class="anchor" aria-hidden="true" id="usage"></a><a href="#usage" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09 [...]
+<p>We provide two options to get you going:</p>
+<ul>
+<li><strong>default</strong>: a light-weight option with few pipeline elements, needs less memory</li>
+<li><strong>full</strong>: contains more pipeline elements, requires <strong>>16 GB RAM</strong> (recommended)</li>
+</ul>
+<p><strong>Starting</strong> the <strong>default</strong> option is as easy as simply running:</p>
+<blockquote>
+<p><strong>NOTE</strong>: Starting might take a while since <code>docker-compose up</code> also initially pulls all Docker images from Dockerhub.</p>
+</blockquote>
+<pre><code class="hljs css language-bash">docker-compose up -d
+<span class="hljs-comment"># go to after all services are started http://localhost</span>
+</code></pre>
+<p>After all containers are successfully started just got to your browser and visit <a href="http://localhost">http://localhost</a> to finish the installation. Once finished, switch to the pipeline editor and start the interactive tour or check the <a href="https://streampipes.apache.org/docs/docs/user-guide-tour/">online tour</a> to learn how to create your first pipeline!</p>
+<p><strong>Stopping</strong> the <strong>default</strong> option is similarly easy:</p>
+<pre><code class="hljs css language-bash">docker-compose down
+<span class="hljs-comment"># if you want to remove mapped data volumes, run:</span>
+<span class="hljs-comment"># docker-compose down -v</span>
+</code></pre>
+<p>Starting the <strong>full</strong> option is almost the same, just specify the <code>docker-compose.full.yml</code> file:</p>
+<pre><code class="hljs css language-bash">docker-compose -f docker-compose.full.yml up -d
+<span class="hljs-comment"># go to after all services are started http://localhost</span>
+</code></pre>
+<p>Stopping the <strong>full</strong> option:</p>
+<pre><code class="hljs css language-bash">docker-compose -f docker-compose.full.yml down
+<span class="hljs-comment">#docker-compose -f docker-compose.full.yml down -v</span>
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="update-services"></a><a href="#update-services" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 [...]
+<p>To actively pull the latest available Docker images use:</p>
+<pre><code class="hljs css language-bash">docker-compose pull
+<span class="hljs-comment"># docker-compose -f docker-compose.full.yml pull</span>
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="upgrade"></a><a href="#upgrade" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1- [...]
+<p>To upgrade to another StreamPipes version, simply edit the <code>SP_VERSION</code> in the <code>.env</code> file.</p>
+<pre><code class="hljs"><span class="hljs-attr">SP_VERSION</span>=<VERSION>
+</code></pre>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/pe/org.apache.streampipes.sinks.notifications.jvm.telegram.html"><span class="arrow-prev">← </span><span>Telegram Publisher</span></a><a class="docs-next button" href="/docs/docs/0.70.0/deploy-kubernetes.html"><span>Kubernetes Deployment</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#prerequisites">Prerequ [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/deploy-kubernetes.html b/docs/docs/0.70.0/deploy-kubernetes.html
new file mode 100644
index 00000000..115fd1f1
--- /dev/null
+++ b/docs/docs/0.70.0/deploy-kubernetes.html
@@ -0,0 +1,130 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Kubernetes Deployment · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Prerequisites"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Kubernetes Deployment [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Kubernetes Deployment</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="prerequisites"></a><a href="#prerequisites" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule [...]
+<p>Requires Helm (<a href="https://helm.sh/">https://helm.sh/</a>) and an active connection to a kubernetes cluster with a running tiller server.</p>
+<p>Tested with:</p>
+<ul>
+<li>K3s v1.18.8+k3s1 (6b595318) with K8s v1.18.8</li>
+<li>Helm v3.1.2</li>
+</ul>
+<h2><a class="anchor" aria-hidden="true" id="usage"></a><a href="#usage" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09 [...]
+<p>We provide two helm chart options to get you going:</p>
+<ul>
+<li><strong>default</strong>: a light-weight option with few pipeline elements, needs less memory</li>
+<li><strong>full</strong>: contains more pipeline elements, requires <strong>>16 GB RAM</strong> (recommended)</li>
+</ul>
+<p><strong>Starting</strong> the <strong>default</strong> helm chart option is as easy as simply running the following command from the root of this folder:</p>
+<blockquote>
+<p><strong>NOTE</strong>: Starting might take a while since we also initially pull all Docker images from Dockerhub.</p>
+</blockquote>
+<pre><code class="hljs css language-bash">helm install streampipes ./
+</code></pre>
+<p>After a while, all containers should successfully started, indicated by the <code>Running</code> status.</p>
+<pre><code class="hljs css language-bash">kubectl get pods
+NAME READY STATUS RESTARTS AGE
+activemq-66d58f47cf-2r2nb 1/1 Running 0 3m27s
+backend-76ddc486c8-nswpc 1/1 Running 0 3m27s
+connect-master-7b477f9b79-8dfvr 1/1 Running 0 3m26s
+connect-worker-78d89c989c-9v8zs 1/1 Running 0 3m27s
+consul-55965f966b-gwb7l 1/1 Running 0 3m27s
+couchdb-77db98cf7b-xnnvb 1/1 Running 0 3m27s
+influxdb-b95b6479-r8wh8 1/1 Running 0 3m27s
+kafka-657b5fb77-dp2d6 1/1 Running 0 3m27s
+pipeline-elements-all-jvm-79c445dbd9-m8xcs 1/1 Running 0 3m27s
+sources-watertank-simulator-6c6b8844f6-6b4d7 1/1 Running 0 3m27s
+ui-b94bd9766-rm6zb 2/2 Running 0 3m27s
+zookeeper-5d9947686f-6nzgs 1/1 Running 0 3m26s
+</code></pre>
+<p>After all containers are successfully started just got to your browser and visit any of the k8s cluster nodes on
+<code>http://<NODE_IP></code> to finish the installation.</p>
+<blockquote>
+<p><strong>NOTE</strong>: If you're running Docker for Mac or Docker for Windows with a local k8s cluster, the above step to use your host IP might not work. Luckily, you can port-forward a service port to your localhost using the following command to be able to access the UI either via <code>http://localhost</code> or <code>http://<HOST_IP></code> (you require sudo to run this command in order to bind to a privileged port).</p>
+</blockquote>
+<pre><code class="hljs css language-bash">kubectl port-forward svc/ui --address=0.0.0.0 80:80
+</code></pre>
+<p>Starting the <strong>full</strong> helm chart option is almost the same:</p>
+<pre><code class="hljs css language-bash">helm install streampipes ./ --<span class="hljs-built_in">set</span> deployment=full
+</code></pre>
+<p><strong>Deleting</strong> the current helm chart deployment:</p>
+<pre><code class="hljs css language-bash">helm del streampipes
+</code></pre>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/deploy-docker.html"><span class="arrow-prev">← </span><span>Docker Deployment</span></a><a class="docs-next button" href="/docs/docs/0.70.0/deploy-use-ssl.html"><span>Use SSL</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#prerequisites">Prerequisites</a></li><li><a href="#usage">Usage</a></li></ul></nav></ [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/deploy-security.html b/docs/docs/0.70.0/deploy-security.html
new file mode 100644
index 00000000..3b446ad4
--- /dev/null
+++ b/docs/docs/0.70.0/deploy-security.html
@@ -0,0 +1,130 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Security · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Overriding default settings"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Security · Apache Str [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Security</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="overriding-default-settings"></a><a href="#overriding-default-settings" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"> [...]
+<p>At installation time, StreamPipes checks for available environment variables relevant for the securing the system. If they are not set, it will use the default values.</p>
+<p>The following variables are checked by the core at installation time:</p>
+<ul>
+<li>SP_INITIAL_ADMIN_EMAIL The email address of the initial administrator.</li>
+<li>SP_INITIAL_ADMIN_PASSWORD The password of the initial administrator.</li>
+<li>SP_INITIAL_CLIENT_USER The initial client user, used by the extensions modules to make authenticated API requests to the core.</li>
+<li>SP_INITIAL_CLIENT_SECRET The default password of the initial client user.</li>
+<li>SP_SETUP_INSTALL_PIPELINE_ELEMENTS Indicates whether pipeline elements should be installed.</li>
+<li>SP_ENCRYPTION_PASSCODE The encryption passcode, used for securely storing secrets (e.g., database connection strings).</li>
+<li>SP_JWT_SECRET The JWT secret, used for signing JWT tokens.</li>
+</ul>
+<p>In addition, all extensions services that perform requests to the core will need to have the following environment variables set:</p>
+<ul>
+<li>SP_CLIENT_USER The client user, used by the extensions modules to make authenticated API requests to the core.</li>
+<li>SP_CLIENT_SECRET The password of the client user.</li>
+</ul>
+<p>Note that there are default values for all environment variables that are set at installation time - make sure to change these settings when moving to production!</p>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Most security-related settings can be set in the configuration section of StreamPipes. The <em>General</em> section allows to set self-service registration and password recovery (both are disabled by default and require a valid email configuration).
+In the <em>Security</em> section, users, service accounts, roles and groups can be configured.</p>
+<h2><a class="anchor" aria-hidden="true" id="user-types"></a><a href="#user-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1 [...]
+<p>StreamPipes distinguishes between User Accounts (real users that interact with StreamPipes over the UI or an API) and Service Accounts (user-independent accounts which solely use StreamPipes over the API).</p>
+<p>User accounts are typically used by extensions service that require API access to the core (e.g., to get a list of running pipelines).</p>
+<h2><a class="anchor" aria-hidden="true" id="permissions"></a><a href="#permissions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>StreamPipes v0.69.0 comes with more advanced mechanisms to manage permissions.
+For each major resource (pipeline elements, pipelines, StreamPipes Connect adapters, dashboards, data explorer views), permissions can be assigned individually to users and groups.</p>
+<p>To ease permission handling, StreamPipes comes with a default number of roles with pre-assigned privileges:</p>
+<h3><a class="anchor" aria-hidden="true" id="roles"></a><a href="#roles" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09 [...]
+<ul>
+<li>Admin The administrator role has full access to all resources.</li>
+<li>Service Admin The service administrator role has full access to all resources, but has no access to the UI.</li>
+<li>Pipeline Admin has full control of pipelines (create, edit, delete, start, stop, pause, resume, etc.).</li>
+<li>Pipeline User has limited control of pipelines (read only).</li>
+<li>Dashboard Admin has full control of dashboards (create, edit, delete, etc.).</li>
+<li>Dashboard User has limited control of dashboards (read only).</li>
+<li>Data Explorer Admin has full control of data explorer views (create, edit, delete, etc.).</li>
+<li>Data Explorer User has limited control of data explorer views (read only).</li>
+<li>Connect Admin has full control of StreamPipes Connect adapters (create, edit, delete, etc.).</li>
+</ul>
+<h3><a class="anchor" aria-hidden="true" id="groups"></a><a href="#groups" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+<p>Roles can be either assigned to specific users or groups. Any group can contain several members.
+The permissions of a user are the union of the permissions of all roles assigned to the user and the groups to which the user belongs.</p>
+<h3><a class="anchor" aria-hidden="true" id="changing-permissions"></a><a href="#changing-permissions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1 [...]
+<p>Any resource has a resource owner, which is the authority that created the resource. Resources can be either public or private. Public resources are available to all users, while the user role determines what the user can do with the resource.
+E.g., a public pipeline created by a user of role ROLE_ADMIN can be edited by all users with role PIPELINE_ADMIN, while the same pipeline can be read by all users with role PIPELINE_USER.</p>
+<p>Permissions can only be changed by admin users currently.
+In the overview section of each resource (e.g., pipelines and dashboards), a permission dialog is available to users with role ROLE_ADMIN. The dialog allows to assign users and groups to the individual resource.</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/deploy-use-ssl.html"><span class="arrow-prev">← </span><span>Use SSL</span></a><a class="docs-next button" href="/docs/docs/0.70.0/extend-setup.html"><span>Development Setup</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#overriding-default-settings">Overriding default settings</a></li><li><a href="#configu [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/deploy-use-ssl.html b/docs/docs/0.70.0/deploy-use-ssl.html
new file mode 100644
index 00000000..9d196fc2
--- /dev/null
+++ b/docs/docs/0.70.0/deploy-use-ssl.html
@@ -0,0 +1,106 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Use SSL · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="This page explains how SSL Certificates can be used to provide transport layer security between your Browser and the Streampipes Backend."/><meta name="docsearch:version" content="0.70. [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Use SSL</h1></header><article><div><span><p>This page explains how SSL Certificates can be used to provide transport layer security between your Browser and the Streampipes Backend.</p>
+<h2><a class="anchor" aria-hidden="true" id="prerequisites"></a><a href="#prerequisites" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>You need a valid Certificate consisting of a Private and a Public Key. Both Keys must be in PEM Format. Please note that your Private Key should never be shared, otherwise the communication can not be considered secure.</p>
+<h2><a class="anchor" aria-hidden="true" id="edit-docker-composeyml"></a><a href="#edit-docker-composeyml" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0 [...]
+<p>In order to use SSL you have to open port 443 on the nginx Service. Incoming insecure Traffic on Port 80 will be automatically rerouted to Port 443.</p>
+<p>The Environment-Variable NGINX_SSL must be set to "true".</p>
+<p>Finally you have to inject the Certificates into the Docker-Container. In the example below, the Certificates are placed in the directory /etc/ssl/private/ on the host machine. Please change the path according to the place where the Certificates are located on your machine. The path after the colon should not be changed!</p>
+<pre><code class="hljs css language-yaml"><span class="hljs-string">[...]</span>
+ <span class="hljs-attr">nginx:</span>
+ <span class="hljs-attr">image:</span> <span class="hljs-string">apachestreampipes/ui</span>
+ <span class="hljs-attr">ports:</span>
+ <span class="hljs-bullet">-</span> <span class="hljs-string">"80:80"</span>
+ <span class="hljs-bullet">-</span> <span class="hljs-string">"443:443"</span>
+ <span class="hljs-attr">environment:</span>
+ <span class="hljs-bullet">-</span> <span class="hljs-string">NGINX_SSL=true</span>
+ <span class="hljs-attr">volumes:</span>
+ <span class="hljs-bullet">-</span> <span class="hljs-string">/etc/ssl/private/private.pem:/etc/nginx/ssl/ssl.pem</span>
+ <span class="hljs-bullet">-</span> <span class="hljs-string">/etc/ssl/private/public.pem:/etc/nginx/ssl/cert.pem</span>
+ <span class="hljs-attr">depends_on:</span>
+ <span class="hljs-bullet">-</span> <span class="hljs-string">backend</span>
+ <span class="hljs-attr">networks:</span>
+ <span class="hljs-attr">spnet:</span>
+<span class="hljs-string">[...]</span>
+</code></pre>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/deploy-kubernetes.html"><span class="arrow-prev">← </span><span>Kubernetes Deployment</span></a><a class="docs-next button" href="/docs/docs/0.70.0/deploy-security.html"><span>Security</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#prerequisites">Prerequisites</a></li><li><a href="#edit-docker-composeyml"> [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-archetype.html b/docs/docs/0.70.0/dev-guide-archetype.html
new file mode 100644
index 00000000..d7683380
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-archetype.html
@@ -0,0 +1,82 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Start Developing · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Self-Service Data Analytics"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Start Developing [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Start Developing</h1></header><article><div><span></span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-development-environment.html"><span class="arrow-prev">← </span><span>Previous</span></a><a class="docs-next button" href="/docs/doc [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-architecture.html b/docs/docs/0.70.0/dev-guide-architecture.html
new file mode 100644
index 00000000..ddd390b0
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-architecture.html
@@ -0,0 +1,121 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Architecture · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="The following picture illustrates the high-level architecture of StreamPipes:"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Architecture</h1></header><article><div><span><p>The following picture illustrates the high-level architecture of StreamPipes:</p>
+<p><img src="/docs/img/architecture/high-level-architecture.png" alt="High Level Architecture of StreamPipes"></p>
+<p>Users mainly interact (besides other UI components) with the <em>Pipeline Editor</em> to create stream processing pipelines based on data streams, data processors and data sinks.
+These reusable pipeline elements are provided by self-contained <em>pipeline element containers</em>, each of them having a semantic description that specifies their characteristics (e.g., input, output and required user input for data processors).
+Each pipeline element container has a REST endpoint that provides these characteristics as a JSON-LD document.</p>
+<p>Pipeline element containers are built using one of several provided <em>wrappers</em>.
+Wrappers abstract from the underlying runtime stream processing framework.
+Currently, the StreamPipes framework provides wrappers for Apache Flink, Esper and algorithms running directly on the JVM.</p>
+<p>The <em>pipeline manager</em> manages the definition and execution of pipelines.
+When creating pipelines, the manager continuously matches the pipeline against its semantic description and provides user guidance in form of recommendations.
+Once a pipeline is started, the pipeline manager invokes the corresponding pipeline element containers.
+The container prepares the actual execution logic and submits the program to the underlying execution engine, e.g., the program is deployed in the Apache Flink cluster.</p>
+<p>Pipeline elements exchange data using one or more message brokers and protocols (e.g., Kafka or MQTT).
+StreamPipes does not rely on a specific broker or message format, but negotiates suitable brokers based on the capabilities of connected pipeline elements.</p>
+<p>Thus, StreamPipes provides a higher-level abstraction of existing stream processing technology by leveraging domain experts to create streaming analytics pipelines in a self-service manner.</p>
+<h2><a class="anchor" aria-hidden="true" id="semantic-description"></a><a href="#semantic-description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1 [...]
+<p>Pipeline elements in StreamPipes are meant to be reusable:</p>
+<ul>
+<li>Data processors and data sink are generic (or domain-specific) elements that express their requirements and are able to operate on any stream that satisfies these requirements.</li>
+<li>Data processors and data sinks can be manually configured by offering possible configuration parameters which users can individually define when creating pipelines.</li>
+<li>Data streams can be connected to any data processor or data sink that matches the capabilities of the stream.</li>
+</ul>
+<p>When users create pipelines by connecting a data stream with a data processor (or further processors), the pipeline manager <em>matches</em> the input stream of a data processor against its requirements.
+This matching is performed based on the _semantic description of each element.
+The semantic description (technically an RDF graph serialized as JSON-LD) can be best understood by seeing it as an envelope around a pipeline element.
+It only provides metadata information, while we don't rely on any RDF at runtime for exchanging events between pipeline elements.
+While RDF-based metadata ensures good understanding of stream capabilities, lightweight event formats at runtime (such as JSON or Thrift) ensure fast processing of events.</p>
+<p>Let's look at an example stream that produces a continuous stream of vehicle positions as illustrated below:</p>
+<p><img src="/docs/img/architecture/semantic-description-stream.png" alt="Semantic description of data streams"></p>
+<p>While the runtime layer produces plain JSON by submitting actual values of the position and the vehicle's plate number, the description layer describes various characteristics of the stream:
+For instance, it defines the event schema (including, besides the data type and the runtime name of each property also a more fine-grained meaning of the property), quality aspects (e.g., the measurement unit of a property or the frequency) and the grounding (e.g., the format used at runtime and the communication protocol used for transmitting events).</p>
+<p>The same accounts for data processors and data sinks:</p>
+<p><img src="/docs/img/architecture/semantic-description-processor.png" alt="Semantic description of data processor"></p>
+<p>Data processors (and, with some differences, data sinks) are annotated by providing metadata information on their required input and output.
+For instance, we can define minimum schema requirements (such as geospatial coordinates that need to be provided by any stream that is connected to a processor), but also required (minimum or maximum) quality levels and supported transport protocols and formats.
+In addition, required configuration parameters users can define during the pipeline definition process are provided by the semantic description.</p>
+<p>Once new pipeline elements are imported into StreamPipes, we store all information provided by the description layer in a central repository and use this information to guide useres through the pipeline definition process.</p>
+<p>Don't worry - you will never be required to model RDF by yourself.
+Our SDK provides convenience methods that help creating the description automatically.</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-introduction.html"><span class="arrow-prev">← </span><span>Introduction</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-development-environment.html"><span>Next</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#semantic-description">Semantic description</a></li></ul></nav></d [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-configuration.html b/docs/docs/0.70.0/dev-guide-configuration.html
new file mode 100644
index 00000000..c6680f8f
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-configuration.html
@@ -0,0 +1,125 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Configuration · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="On this page we explain how the StreamPipes configuration works."/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="o [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Configuration</h1></header><article><div><span><p>On this page we explain how the StreamPipes configuration works.
+StreamPipes allows the individual services (pipeline element containers and third-party services) to store configuration parameters in a distributed key-value store.
+This has the advantage that individual services do not need to store any configurations on the local file system, enabling us to run containers anywhere.
+As a key-value store we use <a href="https://www.consul.io/">Consul</a>, which is an essential service for all our services.</p>
+<p><img src="/docs/img/configuration/consul.png" width="50%" alt="Semantic description of data processor"></p>
+<h2><a class="anchor" aria-hidden="true" id="edit-configurations"></a><a href="#edit-configurations" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.2 [...]
+<p>All services in StreamPipes can have configuration parameters.
+You can either change them in the consul user interface (which is by default running on port 8500) or directly in the StreamPipes Configurations Page.
+Once a new pipeline element container is started, it is registered in Consul and the parameters can be edited in the configuration page, as shown below.
+To store changes in Consul, the update button must be clicked.</p>
+<div class="my-carousel">
+ <img src="/docs/img/configuration/configuration_1.png" alt="Configuration View">
+</div>
+<h2><a class="anchor" aria-hidden="true" id="configuration-for-developers"></a><a href="#configuration-for-developers" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 [...]
+<p>We provide a Configurations API for the use of configuration parameters in your services.
+Each processing element project has a “config” package <a href="https://github.com/apache/incubator-streampipes-extensions/tree/dev/streampipes-sinks-internal-jvm/src/main/java/org/streampipes/sinks/internal/jvm/config">[Example]</a>.
+This package usually contains two classes.
+One containing unique keys for the configuration values and one containing the getter and setter methods to access these values.
+For the naming of configuration keys, we recommend to use “SP” as a prefix.
+As we explain later, it is possible to set default configurations as environment variables, this prefix makes them unique on your server.
+A configuration entry needs a unique config key. For this key, a value can be specified containing the configuration, like for example the port number of the service.
+For each configuration, a description explaining the parameter can be provided, further the data type must be specified and whether it is a password or not.
+Below, the schema of a configuration item is shown on the left and an example of a port configuration on the right.</p>
+<p><img src="/docs/img/configuration/config_key.png" width="80%" alt="Semantic description of data processor"></p>
+<p>As a developer, you can add as many new configurations to services as you wish, but there are some that are required for all processing element containers.
+Those are <strong>the host</strong>, <strong>the port</strong>, and <strong>the name</strong> of the service.</p>
+<h2><a class="anchor" aria-hidden="true" id="default-values"></a><a href="#default-values" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>You can provide default values for the configurations, which are used when a configuration is read for the first time.
+The first option is to register a configuration parameter in the Config class.
+This is a fallback value, which is used if nothing else is defined.
+Since this value is static, we offer a second option.
+It is possible to provide a default value by setting an environment variable.
+In this case, the convention is that the key of a configuration parameter must be used as the environment variable.
+Now, this value is used instead of the value defined in the Config class.
+During development, the configuration values often need to be changed for debugging purposes, therefore we provide an .env file in all processing element projects and archetypes.
+This file can be used by your IDE to set the environment variables. (e.g., <a href="https://plugins.jetbrains.com/plugin/7861-envfile">Intellij Plugin</a>)
+When you need to change the variable at runtime, you can do this in the StreamPipes configurations as explained before.
+Those changes take effect immediately without the need of a container restart.</p>
+<div class="admonition warning">
+<div class="admonition-title">Installed pipeline elements</div>
+<p>Be cautious, when the configuration is used in the semantic description of a processing element which is already installed in StreamPipes, you have to reload this element in StreamPipes (my elements -> reload).
+ In addition, changes might affect already running pipelines.</p>
+</div>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-ssl.html"><span class="arrow-prev">← </span><span>dev-guide-ssl</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#edit-configurations">Edit Configurations</a></li><li><a href="#configuration-for-developers">Configuration for Developers</a></li><li><a href="#default-values">Default Values</a></li></ul></nav></div><div><footer class=" [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-development-environment.html b/docs/docs/0.70.0/dev-guide-development-environment.html
new file mode 100644
index 00000000..79ede03d
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-development-environment.html
@@ -0,0 +1,175 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Development Environment · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="In this section, we describe our recommended minimum setup for locally setting up a development instance of StreamPipes needed to develop, run and test new pipeline elem [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Development Environment</h1></header><article><div><span><p>In this section, we describe our recommended minimum setup for locally setting up a development instance of StreamPipes needed to develop, run and test new pipeline elements.</p>
+<h2><a class="anchor" aria-hidden="true" id="ide--required-dev-tools"></a><a href="#ide--required-dev-tools" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 [...]
+<p>StreamPipes does not have specific requirements on the IDE - so feel free to choose the IDE of your choice.
+The only requirements in terms of development tools are that you have Java 8 and Maven installed.</p>
+<h2><a class="anchor" aria-hidden="true" id="docker-based-local-streampipes-instance"></a><a href="#docker-based-local-streampipes-instance" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 [...]
+<p>In order to quickly test developed pipeline elements without needing to install all services required by StreamPipes, we provide a CLI tool that allows you to selectively start StreamPipes components.
+The CLI tool allows to switch to several templates (based on docker-compose) depending on the role. For instance, if you are developing a pipeline element, use the template <code>pe-developer</code>. This will start backend and ui components in a Docker container, while you can easily test your pipeline element in your IDE.</p>
+<p>For now, we refer to the Github Readme for instructions on how to use the CLI tool: <a href="https://github.com/apache/incubator-streampipes-installer">https://github.com/apache/incubator-streampipes-installer</a></p>
+<h2><a class="anchor" aria-hidden="true" id="starter-projects"></a><a href="#starter-projects" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
+<p>Now, once you've started the development instance, you are ready to develop your very first pipeline element.
+Instead of starting from scratch, we recommend using our provided maven archetypes:</p>
+<h3><a class="anchor" aria-hidden="true" id="maven-archetypes"></a><a href="#maven-archetypes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
+<p>Create the Maven archetype as described in the <a href="/docs/dev-guide-archetype">Getting Started</a> guide.</p>
+<h3><a class="anchor" aria-hidden="true" id="starting-from-scratch"></a><a href="#starting-from-scratch" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2 [...]
+<p>In order to develop a new pipeline element from scratch, you need to create a new Maven project and import the following dependencies:</p>
+<p><details class="info">
+<summary>pom.xml</summary></p>
+<pre><code class="hljs"><span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-container-standalone<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.64.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+
+<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-sdk<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.64.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+
+<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-vocabulary<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.64.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+
+<span class="hljs-comment"><!-- This dependency needs to be imported if you plan to develop a new data processor or data sink using the Apache Flink wrapper --></span>
+<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-wrapper-flink<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.64.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+
+<span class="hljs-comment"><!-- This dependency needs to be imported if you plan to develop a new data processor or data sink which is running directly on the JVM --></span>
+<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-wrapper-standalone<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.64.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+
+<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-dataformat-json<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.64.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-dataformat-smile<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.64.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-dataformat-cbor<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.64.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-dataformat-fst<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.64.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-messaging-jms<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.64.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-messaging-kafka<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.64.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+</code></pre>
+<p></details></p>
+<p>The following three dependencies are mandatory:</p>
+<ul>
+<li><code>streampipes-container-standalone</code>, defines that we are going to create a new pipeline element where the description will be accessible through an embedded web server.</li>
+<li><code>streampipes-sdk</code> imports the SDK which provides many convencience functions to create new pipeline elements.</li>
+<li><code>streampipes-vocabulary</code> imports various RDF vocabularies which are used by the SDK to auto-generate the semantic description of pipeline elements.</li>
+</ul>
+<p>The following three dependencies might be optional depending on the pipeline element type you plan to create:</p>
+<ul>
+<li><code>streampipes-wrapper-flink</code> should be used in case you plan to connect a new data processor or data sink that uses Apache Flink for processing events at runtime.</li>
+<li><code>streampipes-wrapper-standalone</code> should be used in case you plan to connect a new data processor or data sink that does not use an external processing engine. Events are directly processed in a single-host fashion.</li>
+</ul>
+<p>Finally, this dependency will provide abstract classes to define data sources and streams.</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-architecture.html"><span class="arrow-prev">← </span><span>dev-guide-architecture</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-archetype.html"><span>Start Developing</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#ide--required-dev-tools">IDE & required dev tools</a> [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-event-model.html b/docs/docs/0.70.0/dev-guide-event-model.html
new file mode 100644
index 00000000..476188da
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-event-model.html
@@ -0,0 +1,175 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SDK Guide: Event Model · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Introduction"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="SDK Guide: Event Model [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">SDK Guide: Event Model</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="introduction"></a><a href="#introduction" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule= [...]
+<p>The 0.61.0 release of StreamPipes introduces a new event model that replaces the <code>Map</code> representation of events at runtime. This guide explains the usage of the new event model to manipulate runtime events for data processors and data sink.</p>
+<h2><a class="anchor" aria-hidden="true" id="reference"></a><a href="#reference" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>This guide assumes that you are already familiar with the basic setup of <a href="/docs/docs/0.70.0/dev-guide-sdk-guide-processors.html">data processors</a> and <a href="/docs/docs/0.70.0/dev-guide-sdk-guide-sinks.html">data sinks</a>.</p>
+<h3><a class="anchor" aria-hidden="true" id="property-selectors"></a><a href="#property-selectors" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22- [...]
+<p>In most cases, fields that are subject to be transformed by pipeline elements are provided by the assigned <code>MappingProperty</code> (see the guide on <a href="/docs/docs/0.70.0/dev-guide-static-properties.html">static properties</a>).</p>
+<p>Mapping properties return a <code>PropertySelector</code> that identifies a field based on (i) the <strong>streamIndex</strong> and (ii) the runtime name of the field.
+Let's assume we have an event with the following structure:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temperature"</span> : <span class="hljs-number">37.0</span>,
+ <span class="hljs-attr">"deviceId"</span> : <span class="hljs-string">"sensor1"</span>,
+ <span class="hljs-attr">"running"</span> : <span class="hljs-literal">true</span>,
+ <span class="hljs-attr">"location"</span> : {<span class="hljs-attr">"latitude"</span> : <span class="hljs-number">34.4</span>, <span class="hljs-attr">"longitude"</span> : <span class="hljs-number">-47</span>},
+ <span class="hljs-attr">"lastValues"</span> : [<span class="hljs-number">45</span>, <span class="hljs-number">22</span>, <span class="hljs-number">21</span>]
+}
+</code></pre>
+<p>In addition, we assume that a data processor exists (with one input node) that converts the temperature value (measured in degrees celsius) to a degree fahrenheit value.
+In this case, a mapping property (selected by the pipeline developer in the StreamPipes UI) would link to the <code>temperature</code> field of the event.</p>
+<p>The mapping property value will be the <code>PropertySelector</code> of the temperature value, which looks as follows:</p>
+<pre><code class="hljs">s0::temperature
+</code></pre>
+<p><code>s0</code> identifies the stream (in this case, only one input streams exist, but as data processors might require more than one input stream, a stream identifier is required), while the appendix identifies the runtime name.</p>
+<p>Note: If you add a new field to an input event, you don't need to provide the selector, you can just assign the runtime name as defined by the <a href="/docs/docs/0.70.0/dev-guide-output-strategies.html">output strategy</a>.</p>
+<h3><a class="anchor" aria-hidden="true" id="reading-fields"></a><a href="#reading-fields" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>You can get a field from an event by providing the corresponding selector:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event, SpOutputCollector out)</span> </span>{
+
+ PrimitiveField temperatureField = event.getFieldBySelector(PROPERTY_SELECTOR).getAsPrimitive();
+ }
+
+</code></pre>
+<p>Similarly, if your mapping property links to a nested property, use</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event, SpOutputCollector out)</span> </span>{
+
+ NestedField nestedField = event.getFieldBySelector(PROPERTY_SELECTOR).getAsNested();
+ }
+
+</code></pre>
+<p>and for a list-based field:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event, SpOutputCollector out)</span> </span>{
+
+ ListField listField = event.getFieldBySelector(PROPERTY_SELECTOR).getAsList();
+ }
+
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="parsing-fields"></a><a href="#parsing-fields" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<h4><a class="anchor" aria-hidden="true" id="primitive-fields"></a><a href="#primitive-fields" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
+<p>A <code>PrimitiveField</code> contains convenience methods to directly cast a field to the target datatype:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-comment">// parse the value as a float datatype</span>
+Float temperatureValue = event.getFieldBySelector(temperatureSelector).getAsPrimitive().getAsFloat();
+
+<span class="hljs-comment">// or do the same with a double datatype</span>
+Double temperatureValue = event.getFieldBySelector(temperatureSelector).getAsPrimitive().getAsDouble();
+
+<span class="hljs-comment">// extracting a string</span>
+String deviceId = event.getFieldBySelector(deviceIdSelector).getAsPrimitive().getAsString();
+
+<span class="hljs-comment">// this also works for extracting fields from nested fields:</span>
+Double latitude = event.getFieldBySelector(latitudeSelector).getAsPrimitive().getAsDouble();
+
+<span class="hljs-comment">// extracting boolean values</span>
+Boolean running = event.getFieldBySelector(runningSelector).getAsPrimitive().getAsBoolean();
+</code></pre>
+<p>In rare cases, you might want to receive a field directly based on the runtime name as follows:</p>
+<pre><code class="hljs css language-java">Double temperature = event.getFieldByRuntimeName(<span class="hljs-string">"temperature"</span>).getAsPrimitive().getAsDouble();
+</code></pre>
+<h4><a class="anchor" aria-hidden="true" id="list-fields"></a><a href="#list-fields" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Lists can also be retrieved by providing the corresponding selector and can automatically be parsed to a list of primitive datatypes:</p>
+<pre><code class="hljs css language-java">
+List<Integer> lastValues = event.getFieldBySelector(lastValueSelector).getAsList().parseAsSimpleType(Integer<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+
+</code></pre>
+<p>(coming soon: parsing complex lists)</p>
+<h3><a class="anchor" aria-hidden="true" id="addingupdating-fields"></a><a href="#addingupdating-fields" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2 [...]
+<p>Primitive fields can easily be added to an event by providing the runtime name and the object:</p>
+<pre><code class="hljs css language-java">
+ <span class="hljs-comment">// add a primitive field with runtime name "city" and value "Karlsruhe"</span>
+ event.addField(<span class="hljs-string">"city"</span>, <span class="hljs-string">"Karlsruhe"</span>);
+
+ <span class="hljs-comment">// remove the field "temperature" from the event</span>
+ event.removeFieldBySelector(temperatureSelector);
+
+ <span class="hljs-comment">// add a new field</span>
+ event.addField(<span class="hljs-string">"fahrenheit"</span>, <span class="hljs-number">48</span>);
+</code></pre>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-output-strategies.html"><span class="arrow-prev">← </span><span>dev-guide-output-strategies</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-ssl.html"><span>dev-guide-ssl</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#introduction">Introduction</a></li><li><a href="#referen [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-introduction.html b/docs/docs/0.70.0/dev-guide-introduction.html
new file mode 100644
index 00000000..a1f4b1a6
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-introduction.html
@@ -0,0 +1,115 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Introduction · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="StreamPipes is an open platform which can be easily extended at runtime by adding new data streams, data processors and data sinks."/><meta name="docsearch:version" content="0.70.0 [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Introduction</h1></header><article><div><span><p>StreamPipes is an open platform which can be easily extended at runtime by adding new data streams, data processors and data sinks.
+When developing new components, usually multiple elements, called <em>pipeline elements</em>, are bundled into a self-contained <em>pipeline element container</em>. This container is deployed as a standalone microservice. This service is self-descriptive and exposes its description (see below for a detailed explanation) to the StreamPipes management backend. Once the service is deployed, it can be installed using the StreamPipes UI and all elements provided by this service are ready to b [...]
+<p>To ease the extension of StreamPipes, we provide a powerful Software Development Kit (SDK) that allows you to define new pipeline elements for your StreamPipes instance.</p>
+<h2><a class="anchor" aria-hidden="true" id="concepts"></a><a href="#concepts" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 [...]
+<p>In this section, we briefly describe the main concepts of StreamPipes. Although it might give an abstract overview, we are sure that many concepts will be more clear once you've created your very first pipeline element yourself. So check out our tutorials!</p>
+<h3><a class="anchor" aria-hidden="true" id="data-stream"></a><a href="#data-stream" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>A <em>Data Stream</em> is the main concept to describe the source of a pipeline. <em>DataStreams</em> consist of
+an RDF <em>description</em> (which will be generated automatically when using the SDK) and a runtime
+<em>implementation</em>. The description includes information on the <em>schema</em> of a data stream, e.g., measurement properties the payload of a stream provides.
+Furthermore, the description contains information on the <em>grounding</em>, such as the transport format (e.g., JSON) and transport protoocol (e.g., MQTT or Kafka).
+One or more data streams are assigned to a <em>Data Source</em> to improve discovery of existing streams.</p>
+<h3><a class="anchor" aria-hidden="true" id="data-processor"></a><a href="#data-processor" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p><em>Data Processors</em> transform on or more input event streams to an output event stream. Data processors can be stateless (e.g., filter operations on every event of an input stream) or stateful (e.g., time-based aggregations using sliding windows).
+Similar to data streams, processors consist of an RDF <em>description</em> and a corresponding <em>implementation</em>. The description is being used by the StreamPipes backend in order to determine the compatibility of a data processor and an input event stream and includes information the required minimum event schema as well as required user input and the definition of the output event stream.</p>
+<p>The implementation of a data processor can be defined using a set of provided <em>runtime wrappers</em>. These wrappers define where computation logic actually takes place once a pipeline was started. We currently provide runtime wrappers for various Big Data processing engines (e.g., Apache Flink) and lightweight standalone processors.</p>
+<h3><a class="anchor" aria-hidden="true" id="data-sink"></a><a href="#data-sink" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>The concept of <em>Data Sinks</em> is very similar to the concept of data processors with the exception that sinks do not produce any output streams.
+Therefore, sinks are used in StreamPipes to mark the end of a pipeline and reflect 3rd party applications, notifications or dashboard components.</p>
+<h3><a class="anchor" aria-hidden="true" id="static-property"></a><a href="#static-property" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 [...]
+<p>Some data processors or data sinks might require input from users when pipelines are created using these elements.
+For instance, a generic filter component might require information on the filter operation and a threshold value.
+Such required user input can be modeled by defining <em>static properties</em>. Static properties can be defined in many ways, e.g., plain text input, selections (e.g., radio buttons) or can be linked to separately stored domain knowledge.
+The SDK contains many convenient functions that help you defining static properties.</p>
+<h3><a class="anchor" aria-hidden="true" id="output-strategy"></a><a href="#output-strategy" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 [...]
+<p>As mentioned above, data processors also define the output event schema. However, as data processors in StreamPipes are often generic and can therefore be linked to any event stream that matches the input requirement of a data processor, the exact output schema is not known in the development phase when a data processor is defined.
+Therefore, data processors define their output using <em>output strategies</em>. Such strategies describe the transformation process, i.e., how an input stream is transformed to an output stream.
+Multiple pre-defined output strategies exist that you can choose depending on the behaviour of a data processor.
+For instance, the output schema of a filter component is usually similar to the input schema, so you would use a <em>KeepOutputStrategy</em>.
+On the other hand, an enrichment component usually adds additional properties to an input schema - this can be defined using a <em>AppendOutputStrategy</em>.
+Sometimes you want to let the user define the output schema. In this case, a <em>CustomOutputStrategy</em> can be defined.</p>
+<h2><a class="anchor" aria-hidden="true" id="clients"></a><a href="#clients" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1- [...]
+<p>As stated in the beginning, pipeline element containers are deployed as self-contained microservices. The client types describes the environment this service is running in.
+Currently supported clients are <em>standalone</em>, which defines a standalone service that contains both the description and implementation part (which is often submitted to a computing cluster prior to pipeline execution) in addition to an embedded Jetty web server which creates a fat jar file, and <em>embedded</em>, which creates a war file that can be imported into an existing application server.</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-architecture.html"><span>dev-guide-architecture</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#concepts">Concepts</a><ul class="toc-headings"><li><a href="#data-stream">Data Stream</a></li><li><a href="#data-processor">Data Processor</a></li><li><a href="#data-sink">Data Sink</a></li><li><a href= [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-migration.html b/docs/docs/0.70.0/dev-guide-migration.html
new file mode 100644
index 00000000..3b41849c
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-migration.html
@@ -0,0 +1,243 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Migration Guide v0.61 · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Version 0.61.0 of StreamPipes comes with an improved event model. This model makes it easier to support more complex data streams (e.g., streams containing nested properti [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Migration Guide v0.61</h1></header><article><div><span><p>Version 0.61.0 of StreamPipes comes with an improved event model. This model makes it easier to support more complex data streams (e.g., streams containing nested properties and lists) and includes features such as automatically resolving con [...]
+<p>If you are only using the pipeline elements that are included in StreamPipes, you only need to update the element description (My Elements -> Update).
+However, if you've already developed your own pipeline elements, some code changes are required to make your elements work with versions >= 0.61.0.</p>
+<div class="admonition info">
+<div class="admonition-title">Don't be afraid!</div>
+<p>Although this guide may look long and complicated, migrating pipeline elements is quite simple. Once you've understood how the new event model works, you'll be able to migrate an element within just a few minutes.</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="migrating-data-processors"></a><a href="#migrating-data-processors" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c [...]
+<h3><a class="anchor" aria-hidden="true" id="jvm-wrapper"></a><a href="#jvm-wrapper" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<h4><a class="anchor" aria-hidden="true" id="engine-class"></a><a href="#engine-class" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83. [...]
+<ol>
+<li>Make the class <strong>implement</strong> <code>EventProcessor</code> instead of <strong>extending</strong> <code>StandaloneEventProcessorEngine</code></li>
+</ol>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// old</span>
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyProcessor</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">StandaloneEventProcessorEngine</span><<span class="hljs-title">MyProcessorParameters</span>> </span>{ ... }
+
+<span class="hljs-comment">// new</span>
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyProcessor</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">EventProcessor</span><<span class="hljs-title">MyProcessorParameters</span>></span>{ ... }
+</code></pre>
+<ol start="2">
+<li>Change the signature of the <code>onInvocation</code> method:</li>
+</ol>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// old</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onInvocation</span><span class="hljs-params">(MyProcessorParameters params, DataProcessorInvocation dataProcessorInvocation)</span> </span>{
+
+ }
+
+<span class="hljs-comment">// new</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onInvocation</span><span class="hljs-params">(MyProcessorParameters params, SpOutputCollector spOutputCollector, EventProcessorRuntimeContext runtimeContext)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+
+ }
+</code></pre>
+<ol start="3">
+<li>Change the signature of the <code>onEvent</code> method:</li>
+</ol>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// old</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Map<String, Object> in, String s, SpOutputCollector out)</span> </span>{
+
+ }
+
+<span class="hljs-comment">// new</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event in, SpOutputCollector out)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+
+ }
+</code></pre>
+<ol start="4">
+<li>Refactor the <code>onEvent</code>method to the new event model:</li>
+</ol>
+<ul>
+<li>Replace all <code>collector.onEvent()</code> calls to the collector with <code>collector.collect()</code></li>
+<li>Replace all fields that are accessed from a <strong>MappingProperty</strong> with the new <strong>FieldSelector</strong> from the Event class, e.g.:</li>
+</ul>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// old</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Map<String, Object> in, String s, SpOutputCollector out)</span> </span>{
+ String value = String.valueOf(in.get(valueField));
+ }
+
+<span class="hljs-comment">// new</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event in, SpOutputCollector out)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+ String value = in.getFieldBySelector(valueField).getAsPrimitive().getAsString();
+ }
+</code></pre>
+<p>See the documentation on the event class for further details.</p>
+<ol start="5">
+<li><p>Forward an <code>Event</code> instead of a <code>Map</code> to the collector. If needed, create a new instance of the <code>Event</code> class.</p></li>
+<li><p>Modify the modifications of the input event, e.g.:</p></li>
+</ol>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// old</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Map<String, Object> in, String s, SpOutputCollector out)</span> </span>{
+ in.put(<span class="hljs-string">"new"</span>, <span class="hljs-string">"a new field"</span>);
+ out.onEvent(in);
+ }
+
+<span class="hljs-comment">// new</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event in, SpOutputCollector out)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+ in.addField(<span class="hljs-string">"new"</span>, <span class="hljs-string">"a new field"</span>);
+ out.collect(in);
+ }
+</code></pre>
+<h4><a class="anchor" aria-hidden="true" id="controller"></a><a href="#controller" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1 [...]
+<ol>
+<li>In the <code>onInvocation</code> method, use a method reference instead of the lambda expression as return type:</li>
+</ol>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// old</span>
+<span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> ConfiguredEventProcessor<>(params, () -> <span class="hljs-keyword">new</span> MyProcessor(params));
+
+<span class="hljs-comment">// new</span>
+<span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> ConfiguredEventProcessor<>(params, MyProcessor::<span class="hljs-keyword">new</span>);
+</code></pre>
+<ol start="2">
+<li>Change the signature of the <code>onInvocation</code> method:</li>
+</ol>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// old</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> ConfiguredEventProcessor<MyParameters> <span class="hljs-title">onInvocation</span><span class="hljs-params">(DataProcessorInvocation graph)</span> </span>{ ... }
+
+<span class="hljs-comment">// new</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> ConfiguredEventProcessor<MyParameters> <span class="hljs-title">onInvocation</span><span class="hljs-params">(DataProcessorInvocation graph, ProcessingElementParameterExtractor extractor)</span> </span>{ ... }
+</code></pre>
+<ol start="3">
+<li>If existing, remove the <code>fromExtractor</code> method and use the provided <code>ProcessingElementParameterExtractor</code></li>
+</ol>
+<h3><a class="anchor" aria-hidden="true" id="flink-wrapper"></a><a href="#flink-wrapper" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h2><a class="anchor" aria-hidden="true" id="migrating-data-sinks"></a><a href="#migrating-data-sinks" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1 [...]
+<h3><a class="anchor" aria-hidden="true" id="jvm-wrapper-1"></a><a href="#jvm-wrapper-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h4><a class="anchor" aria-hidden="true" id="sink-class"></a><a href="#sink-class" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1 [...]
+<ol>
+<li>Make the class <strong>implement</strong> <code>EventSink</code> instead of <strong>extending</strong> <code>EventSink</code></li>
+</ol>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// old</span>
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MySink</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">EventSink</span><<span class="hljs-title">MySinkParameters</span>> </span>{ ... }
+
+<span class="hljs-comment">// new</span>
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MySink</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">EventSink</span><<span class="hljs-title">MySinkParameters</span>></span>{ ... }
+</code></pre>
+<ol start="2">
+<li><p>If present, remove the constructor that includes the parameter class.</p></li>
+<li><p>Change the <code>bind</code> method to <code>onInvocation</code> as follows:</p></li>
+</ol>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// old</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">bind</span><span class="hljs-params">(DemonstratorValveParameters parameters)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{ ... }
+
+<span class="hljs-comment">// new</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onInvocation</span><span class="hljs-params">(DemonstratorValveParameters parameters, EventSinkRuntimeContext runtimeContext)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{ ... }
+</code></pre>
+<ol start="4">
+<li>Change the signature of the <code>onEvent</code> method</li>
+</ol>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// old</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Map<String, Object> event, String sourceInfo)</span> </span>{
+
+<span class="hljs-comment">// new</span>
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event)</span> </span>{
+</code></pre>
+<ol start="5">
+<li><p>If necessary, adapt your logic to use the new event object.</p></li>
+<li><p>Rename the <code>discard</code> method to <code>onDetach</code>.</p></li>
+</ol>
+<h4><a class="anchor" aria-hidden="true" id="controller-1"></a><a href="#controller-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83. [...]
+<ol>
+<li>In the <code>onInvocation</code> method, use a method reference instead of the lambda expression as return type:</li>
+</ol>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// old</span>
+<span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> ConfiguredEventSink<>(params, () -> <span class="hljs-keyword">new</span> MySink(params));
+
+<span class="hljs-comment">// new</span>
+<span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> ConfiguredEventSink<>(params, MySink::<span class="hljs-keyword">new</span>);
+</code></pre>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-archetype.html"><span class="arrow-prev">← </span><span>Start Developing</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-tutorial-sources.html"><span>dev-guide-tutorial-sources</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#migrating-data-processors">Migrating Data Process [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-output-strategies.html b/docs/docs/0.70.0/dev-guide-output-strategies.html
new file mode 100644
index 00000000..359ea89b
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-output-strategies.html
@@ -0,0 +1,340 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SDK Guide: Output Strategies · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Introduction"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="SDK Guide: Outpu [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">SDK Guide: Output Strategies</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="introduction"></a><a href="#introduction" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill [...]
+<p>In StreamPipes, output strategies determine the output of a data processor.
+As the exact input schema of a processor is usually not yet known at development time (as processors can be connected with any stream that matches their requirements), output strategies are a concept to define how an input data stream is transformed to an output data stream.</p>
+<p>The following reference describes how output strategies can be defined using the SDK.</p>
+<div class="admonition tip">
+<div class="admonition-title">Code on Github</div>
+<p>For all examples, the code can be found on <a href="https://www.github.com/apache/incubator-streampipes-examples/tree/dev/streampipes-pipeline-elements-examples-processors-jvm/src/main/java/org/streampipes/pe/examples/jvm/outputstrategy/">Github</a>.</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="reference"></a><a href="#reference" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>The methods described below to create static properties are available in the <code>ProcessingElementBuilder</code> class and are usually used in the <code>declareModel</code> method of the controller class.</p>
+<p>As follows, we will use the following example event to explain how output strategies define the output of a data processor:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temperature"</span> : <span class="hljs-number">37.0</span>,
+ <span class="hljs-attr">"deviceId"</span> : <span class="hljs-string">"1"</span>
+
+}
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="keep-output"></a><a href="#keep-output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>A <code>KeepOutputStrategy</code> declares that the output event schema will be equal to the input event schema.
+In other terms, the processor does not change the schema, but might change the values of event properties.</p>
+<p>A keep output strategy can be defined as follows:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".keep"</span>, <span class="hljs-string">"Keep output example example"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredProperty(EpRequirements.anyProperty())
+ .build())
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+
+ <span class="hljs-comment">// declaring a keep output strategy</span>
+ .outputStrategy(OutputStrategies.keep())
+
+ .build();
+ }
+
+</code></pre>
+<p>According to the example above, the expected output event schema of the example input event would be:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temperature"</span> : <span class="hljs-number">37.0</span>,
+ <span class="hljs-attr">"deviceId"</span> : <span class="hljs-string">"1"</span>
+
+}
+</code></pre>
+<p>Data processors that perform filter operations (e.g., filtering temperature values that are above a given threshold) are a common example for using keep output strategies.</p>
+<h3><a class="anchor" aria-hidden="true" id="fixed-output"></a><a href="#fixed-output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83. [...]
+<p>A <code>FixedOutputStrategy</code> declares that the data processor itself provides the event schema. The output schema does not depend on the input event.</p>
+<p>Fixed output strategies need to provide the event schema they produce at development time:</p>
+<pre><code class="hljs css language-java">
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".fixed"</span>, <span class="hljs-string">"Fixed output example"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredProperty(EpRequirements.anyProperty())
+ .build())
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+
+ <span class="hljs-comment">// the fixed output strategy provides the schema</span>
+ .outputStrategy(OutputStrategies.fixed(EpProperties.timestampProperty(<span class="hljs-string">"timestamp"</span>),
+ EpProperties.doubleEp(Labels.from(<span class="hljs-string">"avg"</span>, <span class="hljs-string">"Average value"</span>, <span class="hljs-string">""</span>), <span class="hljs-string">"avg"</span>, SO.Number)))
+
+ .build();
+ }
+
+</code></pre>
+<p>In this example, we declare that the output schema always consists of two fields (<code>timestamp</code> and <code>avg</code>).</p>
+<p>Therefore, an output event should look like:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"avg"</span> : <span class="hljs-number">36.0</span>
+}
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="append-output"></a><a href="#append-output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>An <code>AppendOutputStrategy</code> appends additional fields to a schema of an incoming event stream. For instance, data processors that perform enrichment operations usually make use of append output strategies.</p>
+<p>Similar to the fixed output strategy, the additional fields must be provided at development time in the controller method as follows:</p>
+<pre><code class="hljs css language-java"> <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".append"</span>, <span class="hljs-string">"Append output example"</span>, <span class="hljs-string">""</span>)
+
+ <span class="hljs-comment">// boilerplate code not relevant here, see above</span>
+
+ <span class="hljs-comment">// declaring an append output</span>
+ .outputStrategy(OutputStrategies.append(EpProperties.integerEp(Labels.from(<span class="hljs-string">"avg"</span>,
+ <span class="hljs-string">"The average value"</span>, <span class="hljs-string">""</span>), <span class="hljs-string">"avg"</span>, SO.Number)))
+
+ .build();
+ }
+</code></pre>
+<p>In this case, the output event would have an additional field <code>avg</code>:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temperature"</span> : <span class="hljs-number">37.0</span>,
+ <span class="hljs-attr">"deviceId"</span> : <span class="hljs-string">"1"</span>,
+ <span class="hljs-attr">"avg"</span> : <span class="hljs-number">123.0</span>
+
+}
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="custom-output"></a><a href="#custom-output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>In some cases, pipeline developers using the StreamPipes UI should be able to manually select fields from an input event schema. For such use cases, a <code>CustomOutputStrategy</code> can be used:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".custom"</span>, <span class="hljs-string">"Custom output example"</span>, <span class="hljs-string">""</span>)
+
+ <span class="hljs-comment">// boilerplate code not relevant here, see above</span>
+
+ <span class="hljs-comment">// declaring a custom output</span>
+ .outputStrategy(OutputStrategies.custom())
+
+ .build();
+ }
+
+</code></pre>
+<p>If a data processor defines a custom output strategy, the customization dialog in the pipeline editor will show a dialog to let users select the fields to keep:</p>
+<p><img src="/docs/img/dev-guide-output-strategies/os-custom.png" width="80%" alt="Number Parameter"></p>
+<p>Taking our example, and assuming that the user selects both the <code>timestamp</code> and the <code>temperature</code> the expected output event should look like this:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temperature"</span> : <span class="hljs-number">37.0</span>
+}
+</code></pre>
+<p>How do we know which fields were selected once the data processor is invoked? Use the proper method from the extractor in the <code>onInvocation</code> method:</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> ConfiguredEventProcessor<DummyParameters> <span class="hljs-title">onInvocation</span><span class="hljs-params">(DataProcessorInvocation graph, ProcessingElementParameterExtractor extractor)</span> </span>{
+
+ List<String> outputSelectors = extractor.outputKeySelectors();
+
+ <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> ConfiguredEventProcessor<>(<span class="hljs-keyword">new</span> DummyParameters(graph), DummyEngine::<span class="hljs-keyword">new</span>);
+ }
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="transform-output"></a><a href="#transform-output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
+<p>A <code>TransformOutputStrategy</code> declares that one or more fields of an incoming event stream are transformed. Transformations can be applied to the datatype of the property, the runtime name of the property, or any other scheam-related declaration such as measurement units.</p>
+<h4><a class="anchor" aria-hidden="true" id="static-transform-operations"></a><a href="#static-transform-operations" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 1 [...]
+<p>Static transform operations do not depend on any user input (at pipeline development time) in order to know how to transform a field of an incoming event schema.</p>
+<p>Let's say our data processor transforms strings (that are actually a number) to a number datatype. In this case, we can use a static transform output strategy:</p>
+<pre><code class="hljs css language-java">
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".transform"</span>, <span class="hljs-string">"Transform output example example"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.stringReq(), Labels.from
+ (<span class="hljs-string">"str"</span>, <span class="hljs-string">"The date property as a string"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .build())
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+
+ <span class="hljs-comment">// static transform operation</span>
+ .outputStrategy(OutputStrategies.transform(TransformOperations
+ .staticDatatypeTransformation(<span class="hljs-string">"str"</span>, Datatypes.Long)))
+
+ .build();
+ }
+
+</code></pre>
+<p>Note the mapping property that we use to determine which field of the input event should be transformed.</p>
+<p>The expected output event would look like this:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temperature"</span> : <span class="hljs-number">37.0</span>,
+ <span class="hljs-attr">"deviceId"</span> : <span class="hljs-number">1</span>
+}
+</code></pre>
+<h4><a class="anchor" aria-hidden="true" id="dynamic-transform-operations"></a><a href="#dynamic-transform-operations" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 [...]
+<p>Sometimes, user input depends on the exact transform output. Let's take a field renaming processor as an example, which lets the user rename a field from an input event schema to another field name.
+For such use cases, we can use a <code>DynamicTransformOperation</code>:</p>
+<pre><code class="hljs css language-java">
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".transform"</span>, <span class="hljs-string">"Transform output example example"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.stringReq(), Labels.from
+ (<span class="hljs-string">"str"</span>, <span class="hljs-string">"The date property as a string"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .build())
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+
+ <span class="hljs-comment">// the text input to enter the new runtime name</span>
+ .requiredTextparameter(Labels.from(<span class="hljs-string">"new-runtime-name"</span>, <span class="hljs-string">"New Runtime Name"</span>, <span class="hljs-string">""</span>))
+
+ <span class="hljs-comment">// static transform operation</span>
+ .outputStrategy(OutputStrategies.transform(TransformOperations
+ .dynamicRuntimeNameTransformation(<span class="hljs-string">"str"</span>, <span class="hljs-string">"new-runtime-name"</span>)))
+
+ .build();
+ }
+
+</code></pre>
+<p>For dynamic transform operations, an additional identifier that links to another static property can be assigned and later be fetched in the <code>onInvocation</code> method.</p>
+<p>Assuming we want to rename the field <code>temperature</code> to <code>temp</code>, the resulting output event should look like this:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temp"</span> : <span class="hljs-number">37.0</span>,
+ <span class="hljs-attr">"deviceId"</span> : <span class="hljs-number">1</span>
+}
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="custom-transform-output"></a><a href="#custom-transform-output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 [...]
+<p>Finally, in some cases the output schema cannot be described at pipeline development time. For these (usually rare) cases, a <code>CustomTransformOutput</code> strategy can be used.</p>
+<p>In this case, a callback function will be invoked in the controller class just after a user has filled in any static properties and clicks on <code>Save</code> in the pipeline editor.</p>
+<p>To define a custom transform output, we need to implement an interface in the controller class:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">CustomTransformOutputController</span> <span class="hljs-keyword">extends</span>
+ <span class="hljs-title">StandaloneEventProcessingDeclarer</span><<span class="hljs-title">DummyParameters</span>> <span class="hljs-keyword">implements</span>
+ <span class="hljs-title">ResolvesContainerProvidedOutputStrategy</span><<span class="hljs-title">DataProcessorInvocation</span>, <span class="hljs-title">ProcessingElementParameterExtractor</span>> </span>{
+
+
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> EventSchema <span class="hljs-title">resolveOutputStrategy</span><span class="hljs-params">(DataProcessorInvocation processingElement, ProcessingElementParameterExtractor parameterExtractor)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+
+ }
+}
+</code></pre>
+<p>In addition, the output strategy must be declared in the <code>declareModel</code> method:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".customtransform"</span>, <span class="hljs-string">"Custom transform output example example"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.stringReq(), Labels.from
+ (<span class="hljs-string">"str"</span>, <span class="hljs-string">"The date property as a string"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .build())
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+
+ <span class="hljs-comment">// declare a custom transform output</span>
+ .outputStrategy(OutputStrategies.customTransformation())
+
+ .build();
+ }
+
+</code></pre>
+<p>Once a new pipeline using this data processor is created and the configuration is saved, the <code>resolveOutputStrategy</code> method will be called, so that an event schema can be provided based on the given configuration. An extractor instance (see the guide on static properties) is available to extract the selected static properties and the connected event stream.</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> EventSchema <span class="hljs-title">resolveOutputStrategy</span><span class="hljs-params">(DataProcessorInvocation processingElement, ProcessingElementParameterExtractor parameterExtractor)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+ <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> EventSchema(Arrays
+ .asList(EpProperties
+ .stringEp(Labels.from(<span class="hljs-string">"runtime"</span>, <span class="hljs-string">"I was added at runtime"</span>, <span class="hljs-string">""</span>), <span class="hljs-string">"runtime"</span>, SO.Text)));
+ }
+</code></pre>
+<p>In this example, the output event schema should look like this:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"runtime"</span> : <span class="hljs-string">"Hello world!"</span>
+}
+</code></pre>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-static-properties.html"><span class="arrow-prev">← </span><span>dev-guide-static-properties</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-event-model.html"><span>dev-guide-event-model</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#introduction">Introduction</a></li><li>< [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-sdk-guide-processors.html b/docs/docs/0.70.0/dev-guide-sdk-guide-processors.html
new file mode 100644
index 00000000..03b41f7e
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-sdk-guide-processors.html
@@ -0,0 +1,86 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SDK Guide: Data Processors · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Project Setup"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="SDK Guide: Data P [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">SDK Guide: Data Processors</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="project-setup"></a><a href="#project-setup" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill [...]
+<p>(coming soon, please check the <a href="../dev-guide-tutorial-processors">tutorial</a> to learn how to define data processors)</p>
+<h2><a class="anchor" aria-hidden="true" id="sdk-reference"></a><a href="#sdk-reference" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>The complete SDK reference for defining data processors will follow soon. Please check the SDK's Javadoc for now!</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-sdk-guide-sources.html"><span class="arrow-prev">← </span><span>SDK Guide: Data Sources</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-sdk-guide-sinks.html"><span>SDK Guide: Data Sinks</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#project-setup">Project Setup</a></li><li [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-sdk-guide-sinks.html b/docs/docs/0.70.0/dev-guide-sdk-guide-sinks.html
new file mode 100644
index 00000000..c58f8933
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-sdk-guide-sinks.html
@@ -0,0 +1,86 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SDK Guide: Data Sinks · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Project Setup"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="SDK Guide: Data Sinks [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">SDK Guide: Data Sinks</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="project-setup"></a><a href="#project-setup" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule [...]
+<p>(coming soon, please check the <a href="../dev-guide-tutorial-processors">tutorial</a> to learn how to define sinks)</p>
+<h2><a class="anchor" aria-hidden="true" id="sdk-reference"></a><a href="#sdk-reference" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>The complete SDK reference for defining data sinks will follow soon. Please check the SDK's Javadoc for now!</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-sdk-guide-processors.html"><span class="arrow-prev">← </span><span>SDK Guide: Data Processors</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-stream-requirements.html"><span>dev-guide-stream-requirements</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#project-setup">Project [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-sdk-guide-sources.html b/docs/docs/0.70.0/dev-guide-sdk-guide-sources.html
new file mode 100644
index 00000000..578a3596
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-sdk-guide-sources.html
@@ -0,0 +1,142 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SDK Guide Sources · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Project Setup"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="SDK Guide Sources · Apache [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">SDK Guide Sources</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="project-setup"></a><a href="#project-setup" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="ev [...]
+<p>Open the IDE of your choice and create a new maven project. Add the following dependencies to your pom file:</p>
+<p><details class="info">
+<summary>pom.xml</summary></p>
+<pre><code class="hljs css language-xml"><span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-container-standalone<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.50.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+
+<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-sdk<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.50.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+
+<span class="hljs-comment"><!-- This dependency needs to be imported if you plan to connect a new data stream with StreamPipes --></span>
+<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-sources<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">version</span>></span>0.50.0<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+</code></pre>
+<p></details></p>
+<p>Now you need to create three new classes:</p>
+<p>First, create a new class <code>MyStreamController</code> as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">import</span> org.streampipes.model.SpDataStream;
+<span class="hljs-keyword">import</span> org.streampipes.model.graph.DataSourceDescription;
+<span class="hljs-keyword">import</span> org.streampipes.sources.AbstractAlreadyExistingStream;
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyStreamController</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">AbstractAlreadyExistingStream</span> </span>{
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> SpDataStream <span class="hljs-title">declareModel</span><span class="hljs-params">(DataSourceDescription sep)</span> </span>{
+
+ }
+}
+</code></pre>
+<p>Next, create a new class <code>MyStreamSource</code> as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">import</span> org.streampipes.container.declarer.EventStreamDeclarer;
+<span class="hljs-keyword">import</span> org.streampipes.container.declarer.SemanticEventProducerDeclarer;
+<span class="hljs-keyword">import</span> org.streampipes.model.graph.DataSourceDescription;
+
+<span class="hljs-keyword">import</span> java.util.List;
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyStreamSource</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">SemanticEventProducerDeclarer</span> </span>{
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataSourceDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> <span class="hljs-keyword">null</span>;
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> List<EventStreamDeclarer> <span class="hljs-title">getEventStreams</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> <span class="hljs-keyword">null</span>;
+ }
+}
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="sdk-reference"></a><a href="#sdk-reference" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>The complete SDK reference for defining data processors will follow soon. Please check the SDK's Javadoc for now!</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-tutorial-sinks.html"><span class="arrow-prev">← </span><span>dev-guide-tutorial-sinks</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-sdk-guide-processors.html"><span>SDK Guide: Data Processors</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#project-setup">Project Setup</a> [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-ssl.html b/docs/docs/0.70.0/dev-guide-ssl.html
new file mode 100644
index 00000000..857b858f
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-ssl.html
@@ -0,0 +1,106 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Use SSL · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="In this tutorial we explain how you can use SSL Certificates to provide transport layer security between your Browser and the Streampipes Backend."/><meta name="docsearch:version" conte [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Use SSL</h1></header><article><div><span><p>In this tutorial we explain how you can use SSL Certificates to provide transport layer security between your Browser and the Streampipes Backend.</p>
+<h2><a class="anchor" aria-hidden="true" id="prerequisites"></a><a href="#prerequisites" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>You need a valid Certificate consisting of a Private and a Public Key. Both Keys must be in PEM Format. Please note that your Private Key should never be shared, otherwise the communication can not be considered secure.</p>
+<h2><a class="anchor" aria-hidden="true" id="edit-docker-composeyml"></a><a href="#edit-docker-composeyml" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0 [...]
+<p>In order to use SSL you have to open port 443 on the nginx Service. Incoming insecure Traffic on Port 80 will automatically be reroutet to Port 443.</p>
+<p>The Environment-Variable NGINX_SSL must be set to "true".</p>
+<p>Finally you have to inject the Certificates into the Docker-Container. In the example below, the Certificates are placed in the directory /etc/ssl/private/ on the host machine. Please change the path according to the place where the Certificates are located on your machine. The path after the colon should not be changed!</p>
+<pre><code class="hljs css language-yaml"><span class="hljs-string">[...]</span>
+ <span class="hljs-attr">nginx:</span>
+ <span class="hljs-attr">image:</span> <span class="hljs-string">streampipes/ui</span>
+ <span class="hljs-attr">ports:</span>
+ <span class="hljs-bullet">-</span> <span class="hljs-string">"80:80"</span>
+ <span class="hljs-bullet">-</span> <span class="hljs-string">"443:443"</span>
+ <span class="hljs-attr">environment:</span>
+ <span class="hljs-bullet">-</span> <span class="hljs-string">NGINX_SSL=true</span>
+ <span class="hljs-attr">volumes:</span>
+ <span class="hljs-bullet">-</span> <span class="hljs-string">/etc/ssl/private/private.pem:/etc/nginx/ssl/ssl.pem</span>
+ <span class="hljs-bullet">-</span> <span class="hljs-string">/etc/ssl/private/public.pem:/etc/nginx/ssl/cert.pem</span>
+ <span class="hljs-attr">depends_on:</span>
+ <span class="hljs-bullet">-</span> <span class="hljs-string">backend</span>
+ <span class="hljs-attr">networks:</span>
+ <span class="hljs-attr">spnet:</span>
+<span class="hljs-string">[...]</span>
+</code></pre>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-event-model.html"><span class="arrow-prev">← </span><span>dev-guide-event-model</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-configuration.html"><span>dev-guide-configuration</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#prerequisites">Prerequisites</a></li><li><a href [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-static-properties.html b/docs/docs/0.70.0/dev-guide-static-properties.html
new file mode 100644
index 00000000..bbf7ec4e
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-static-properties.html
@@ -0,0 +1,237 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SDK Guide: Static Properties · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Introduction"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="SDK Guide: Stati [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">SDK Guide: Static Properties</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="introduction"></a><a href="#introduction" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill [...]
+<p>Static properties represent user-faced parameters that are provided by pipeline developers.
+Processing elements can specify required static properties, which will render different UI views in the pipeline editor.</p>
+<p>The following reference describes how static properties can be defined using the SDK.</p>
+<div class="admonition tip">
+<div class="admonition-title">Code on Github</div>
+<p>For all examples, the code can be found on <a href="https://github.com/apache/incubator-streampipes-examples/tree/dev/streampipes-pipeline-elements-examples-processors-jvm/src/main/java/org/streampipes/pe/examples/jvm/staticproperty">Github</a>.</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="reference"></a><a href="#reference" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>The methods described below to create static properties are available in the <code>ProcessingElementBuilder</code> and <code>DataSinkBuilder</code> classes and are usually used in the <code>declareModel</code> method of the controller class.</p>
+<h3><a class="anchor" aria-hidden="true" id="mapping-property"></a><a href="#mapping-property" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
+<p>In StreamPipes, processing elements usually operate on fields of an event stream. For instance, a filter processor operates on a specific field from an input stream (e.g., a field measuring the temperature).
+Typically, pipeline developers should select the exact field where the operations is applied upon by themselves.
+As this field is not yet known at pipeline element development time (as it is defined by the pipeline developer in the pipeline editor), mapping properties serve to map a stream requirement to a specific field from the actual input event stream.</p>
+<h3><a class="anchor" aria-hidden="true" id="unary-mapping-property"></a><a href="#unary-mapping-property" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0 [...]
+<p>A unary mapping property maps a stream requirement to an actual field of an event stream. Therefore, the <code>StreamRequirementsBuilder</code> provides the opportunity to directly add a mapping property based along with a property requirement:</p>
+<pre><code class="hljs css language-java">.requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.numberReq(),
+ Labels.from(<span class="hljs-string">"mp-key"</span>, <span class="hljs-string">"My Mapping"</span>, <span class="hljs-string">""</span>),
+ PropertyScope.NONE)
+ .build())
+</code></pre>
+<p>This leads to a selection dialog in the pipeline element customization which provides the user with a selection of all event properties (fields) from the input stream that match the specified property requirement:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-mapping-unary.png" width="80%" alt="Text"></p>
+<p>At invocation time, the value can be extracted in the <code>onInvocation</code> method as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// Extract the mapping property value</span>
+String mappingPropertySelector = extractor.mappingPropertyValue(<span class="hljs-string">"mp-key"</span>);
+</code></pre>
+<p>Note that this method returns a <code>PropertySelector</code>, which can be used by the event model to extract the actual value of this field.</p>
+<h3><a class="anchor" aria-hidden="true" id="n-ary-mapping-property"></a><a href="#n-ary-mapping-property" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0 [...]
+<p>N-ary mapping properties work similar to unary mapping properties, but allow the mapping of one requirement to multiple event properties matching the requirement:</p>
+<pre><code class="hljs css language-java">.requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredPropertyWithNaryMapping(EpRequirements.numberReq(),
+ Labels.from(<span class="hljs-string">"mp-key"</span>, <span class="hljs-string">"My Mapping"</span>, <span class="hljs-string">""</span>),
+ PropertyScope.NONE)
+ .build())
+</code></pre>
+<p>This renders the following selection, where users can select more than one matching event property:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-mapping-nary.png" width="80%" alt="Text"></p>
+<p>The following snippet returns a list containing the property selectors of all event properties that have been selected:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// Extract the mapping property value</span>
+List<String> mappingPropertySelectors = extractor.mappingPropertyValues(<span class="hljs-string">"mp-key"</span>);
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="free-text-parameters"></a><a href="#free-text-parameters" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1 [...]
+<p>A free-text parameter requires the pipeline developer to enter a single value - which can be a string or another primitive data type.
+The input of free-text parameters can be restricted to specific value ranges or can be linked to the value set of a connected input data stream.</p>
+<h4><a class="anchor" aria-hidden="true" id="text-parameters"></a><a href="#text-parameters" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 [...]
+<p>A text parameter lets the user enter a string value. The following code line in the controller class</p>
+<pre><code class="hljs css language-java">.requiredTextParameter(Labels.from(SP_KEY, <span class="hljs-string">"Example Name"</span>, <span class="hljs-string">"Example Description"</span>))
+</code></pre>
+<p>leads to the following input dialog in the pipeline editor:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-text-parameter.png" width="80%" alt="Text"></p>
+<p>Users can enter any value that will be converted to a string datatype. To receive the entered value in the <code>onInvocation</code> method, use the following method from the <code>ParameterExtractor</code></p>
+<pre><code class="hljs css language-java">String textParameter = extractor.singleValueParameter(SP_KEY, String<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+</code></pre>
+<h4><a class="anchor" aria-hidden="true" id="number-parameters"></a><a href="#number-parameters" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2- [...]
+<p>A number parameter lets the user enter a number value, either a floating-point number or an integer:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// create an integer parameter</span>
+.requiredIntegerParameter(Labels.from(SP_KEY, <span class="hljs-string">"Integer Parameter"</span>, <span class="hljs-string">"Example Description"</span>))
+
+<span class="hljs-comment">// create a float parameter</span>
+.requiredFloatParameter(Labels.from(<span class="hljs-string">"float-key"</span>, <span class="hljs-string">"Float Parameter"</span>, <span class="hljs-string">"Example Description"</span>))
+
+</code></pre>
+<p>leads to the following input dialog in the pipeline editor only accepting integer values:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-number-parameter.png" width="80%" alt="Number Parameter"></p>
+<p>The pipeline editor performs type validation and ensures that only numbers can be added by the user. To receive the entered value in the <code>onInvocation</code> method, use the following method from the <code>ParameterExtractor</code></p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// Extract the integer parameter value</span>
+Integer integerParameter = extractor.singleValueParameter(SP_KEY, Integer<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+
+<span class="hljs-comment">// Extract the float parameter value</span>
+Float floatParameter = extractor.singleValueParameter(<span class="hljs-string">"float-key"</span>, Float<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+
+</code></pre>
+<h4><a class="anchor" aria-hidden="true" id="numbers-with-value-specification"></a><a href="#numbers-with-value-specification" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13. [...]
+<p>You can also specify the value range of a number-based free text parameter:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// create an integer parameter with value range</span>
+.requiredIntegerParameter(Labels.from(SP_KEY, <span class="hljs-string">"Integer Parameter"</span>, <span class="hljs-string">"Example Description"</span>), <span class="hljs-number">0</span>, <span class="hljs-number">100</span>, <span class="hljs-number">1</span>)
+
+</code></pre>
+<p>which renders the following input field:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-number-parameter-with-range.png" width="80%" alt="Number Parameter"></p>
+<p>Receive the entered value in the same way as a standard number parameter.</p>
+<h4><a class="anchor" aria-hidden="true" id="free-text-parameters-linked-to-an-event-property"></a><a href="#free-text-parameters-linked-to-an-event-property" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9z [...]
+<h3><a class="anchor" aria-hidden="true" id="single-value-selections"></a><a href="#single-value-selections" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 [...]
+<p>Single-value selections let the user select from a pre-defined list of options.
+A single-value selection requires to select exactly one option.</p>
+<pre><code class="hljs css language-java">.requiredSingleValueSelection(Labels.from(<span class="hljs-string">"id"</span>, <span class="hljs-string">"Example Name"</span>, <span class="hljs-string">"Example Description"</span>),
+ Options.from(<span class="hljs-string">"Option A"</span>, <span class="hljs-string">"Option B"</span>, <span class="hljs-string">"Option C"</span>))
+
+</code></pre>
+<p>Single-value selections will be rendered as a set of radio buttons in the pipeline editor:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-single-selection.png" width="80%" alt="Number Parameter"></p>
+<p>To extract the selected value, use the following method from the parameter extractor:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// Extract the selected value</span>
+String selectedSingleValue = extractor.selectedSingleValue(<span class="hljs-string">"id"</span>, String<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+</code></pre>
+<div class="admonition tip">
+<div class="admonition-title">Declaring options</div>
+<p>Sometimes, you may want to use an internal name that differs from the display name of an option.
+For that, you can use the method Options.from(Tuple2<String, String>) and the extractor method selectedSingleValueInternalName.</p>
+</div>
+<h3><a class="anchor" aria-hidden="true" id="multi-value-selections"></a><a href="#multi-value-selections" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0 [...]
+<p>Multi-value selections let the user select from a pre-defined list of options, where multiple or no option might be selected.</p>
+<pre><code class="hljs css language-java">.requiredMultiValueSelection(Labels.from(<span class="hljs-string">"id"</span>, <span class="hljs-string">"Example Name"</span>, <span class="hljs-string">"Example Description"</span>),
+ Options.from(<span class="hljs-string">"Option A"</span>, <span class="hljs-string">"Option B"</span>, <span class="hljs-string">"Option C"</span>))
+
+</code></pre>
+<p>Multi-value selections will be rendered as a set of checkboxes in the pipeline editor:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-multi-selection.png" width="80%" alt="Number Parameter"></p>
+<p>To extract the selected value, use the following method from the parameter extractor:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// Extract the selected value</span>
+List<String> selectedMultiValue = extractor.selectedMultiValues(<span class="hljs-string">"id"</span>, String<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="domain-concepts"></a><a href="#domain-concepts" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 [...]
+<p>(coming soon...)</p>
+<h3><a class="anchor" aria-hidden="true" id="collections"></a><a href="#collections" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>You can also define collections based on other static properties.</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// create a collection parameter</span>
+.requiredParameterAsCollection(Labels.from(<span class="hljs-string">"collection"</span>, <span class="hljs-string">"Example Name"</span>, <span class="hljs-string">"Example "</span> +
+ <span class="hljs-string">"Description"</span>), StaticProperties.stringFreeTextProperty(Labels
+ .from(<span class="hljs-string">"text-property"</span>,<span class="hljs-string">"Text"</span>,<span class="hljs-string">""</span>)))
+</code></pre>
+<p>While the items of the collection can be provided in the same way as the underlying static property, the UI provides buttons to add and remove items to the collections.</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-collection.png" width="80%" alt="Number Parameter"></p>
+<p>To extract the selected values from the collection, use the following method from the parameter extractor:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// Extract the text parameter value</span>
+List<String> textParameters = extractor.singleValueParameterFromCollection(<span class="hljs-string">"collection"</span>, String<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="runtime-resolvable-selections"></a><a href="#runtime-resolvable-selections" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 [...]
+<p>In some cases, the options of selection parameters are not static, but depend on other values or might change at runtime. In this case, you can use runtime-resolvable selections.</p>
+<p>First, let your controller class implement <code>ResolvesContainerProvidedOptions</code>:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">RuntimeResolvableSingleValue</span> <span class="hljs-keyword">extends</span>
+ <span class="hljs-title">StandaloneEventProcessingDeclarer</span><<span class="hljs-title">DummyParameters</span>> <span class="hljs-keyword">implements</span> <span class="hljs-title">ResolvesContainerProvidedOptions</span> </span>{ ... }
+</code></pre>
+<p>Next, define the parameter in the <code>declareModel</code> method:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// create a single value selection parameter that is resolved at runtime</span>
+ .requiredSingleValueSelectionFromContainer(Labels.from(<span class="hljs-string">"id"</span>, <span class="hljs-string">"Example Name"</span>, <span class="hljs-string">"Example "</span> +
+ <span class="hljs-string">"Description"</span>))
+</code></pre>
+<p>Finally, implement the method <code>resolveOptions</code>, which will be called at runtime once the processor is used:</p>
+<pre><code class="hljs css language-java"> <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> List<RuntimeOptions> <span class="hljs-title">resolveOptions</span><span class="hljs-params">(String requestId, EventProperty linkedEventProperty)</span> </span>{
+ <span class="hljs-keyword">return</span> Arrays.asList(<span class="hljs-keyword">new</span> RuntimeOptions(<span class="hljs-string">"I was defined at runtime"</span>, <span class="hljs-string">""</span>));
+ }
+</code></pre>
+<p>The UI will render a single-value parameter based on the options provided at runtime:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-single-selection-remote.png" width="80%" alt="Number Parameter"></p>
+<p>The parameter extraction does not differ from the extraction of static single-value parameters.</p>
+<div class="admonition info">
+<div class="admonition-title">Multi-value selections</div>
+<p>Although this example shows the usage of runtime-resolvable selections using single value selections, the same also works for multi-value selections!</p>
+</div>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-stream-requirements.html"><span class="arrow-prev">← </span><span>dev-guide-stream-requirements</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-output-strategies.html"><span>dev-guide-output-strategies</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#introduction">Introducti [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-stream-requirements.html b/docs/docs/0.70.0/dev-guide-stream-requirements.html
new file mode 100644
index 00000000..31af875f
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-stream-requirements.html
@@ -0,0 +1,214 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SDK Guide: Stream Requirements · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Introduction"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="SDK Guide: Str [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">SDK Guide: Stream Requirements</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="introduction"></a><a href="#introduction" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fi [...]
+<p>Data processors and data sinks can define <code>StreamRequirements</code>. Stream requirements allow pipeline elements to express requirements on an incoming event stream that are needed for the element to work properly.
+Once users create pipelines in the StreamPipes Pipeline Editor, these requirements are verified against the connected event stream.
+By using this feature, StreamPipes ensures that only pipeline elements can be connected that are syntactically and semantically valid.</p>
+<p>This guide covers the creation of stream requirements. Before reading this section, we recommend that you make yourself familiar with the SDK guide on <a href="/docs/docs/0.70.0/dev-guide-sdk-guide-processors.html">data processors</a> and <a href="/docs/docs/0.70.0/dev-guide-sdk-guide-sinks.html">data sinks</a>.</p>
+<div class="admonition tip">
+<div class="admonition-title">Code on Github</div>
+<p>For all examples, the code can be found on <a href="https://www.github.com/apache/incubator-streampipes-examples/tree/dev/streampipes-pipeline-elements-examples-processors-jvm/src/main/java/org/streampipes/pe/examples/jvm/requirements/">Github</a>.</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="the-streamrequirementsbuilder"></a><a href="#the-streamrequirementsbuilder" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 [...]
+<p>Stream requirements can be defined in the <code>Controller</code> class of the pipeline element. Start with a method body like this:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(ID, PIPELINE_ELEMENT_NAME, DESCRIPTION)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+
+ .build())
+
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+ .outputStrategy(OutputStrategies.keep())
+
+ .build();
+ }
+</code></pre>
+<p>The <code>StreamRequirementsBuilder</code> class provides methods to add stream requirements to a pipeline element.</p>
+<h2><a class="anchor" aria-hidden="true" id="requirements-on-primitive-fields"></a><a href="#requirements-on-primitive-fields" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13. [...]
+<p>As a very first example, let's assume we would like to create a data processor that filters numerical values that are above a given threshold.
+Consequently, any data stream that is connected to the filter processor needs to provide a numerical value.</p>
+<p>The stream requirement would be assigned as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(ID, PIPELINE_ELEMENT_NAME, DESCRIPTION)
+ .requiredStream(StreamRequirementsBuilder
+ .create()
+ .requiredProperty(EpRequirements.numberReq())
+ .build())
+
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+ .outputStrategy(OutputStrategies.keep())
+
+ .build();
+ }
+</code></pre>
+<p>Note the line starting with <code>requiredProperty</code>, which requires any stream to provide a datatype of type <code>number</code>.</p>
+<p>In many cases, you'll want to let the user select a specific field from a data stream from all available fields that match the specified requirement. For that, you simply use the method <code>requiredPropertyWithUnaryMapping</code> as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(ID, PIPELINE_ELEMENT_NAME, DESCRIPTION)
+ .requiredStream(StreamRequirementsBuilder
+ .create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.numberReq(),
+ Labels.from(<span class="hljs-string">"number-mapping"</span>, <span class="hljs-string">"The value that should be filtered"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .build())
+
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+ .outputStrategy(OutputStrategies.keep())
+
+ .build();
+ }
+</code></pre>
+<p>See also the developer guide on <a href="/docs/docs/0.70.0/dev-guide-static-properties.html">static properties</a> to better understand the usage of <code>MappingProperties</code>.</p>
+<p>Requirements on primitive fields can be specified for all common datatypes:</p>
+<pre><code class="hljs css language-java"> <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.requirements"</span> +
+ <span class="hljs-string">".simple"</span>, <span class="hljs-string">"Simple requirements specification examples"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredProperty(EpRequirements.numberReq()) <span class="hljs-comment">// any number</span>
+ .requiredProperty(EpRequirements.doubleReq()) <span class="hljs-comment">// any field of type double</span>
+ .requiredProperty(EpRequirements.booleanReq()) <span class="hljs-comment">// any field of type boolean</span>
+ .requiredProperty(EpRequirements.integerReq()) <span class="hljs-comment">// any field of type integer</span>
+ .requiredProperty(EpRequirements.stringReq()) <span class="hljs-comment">// any field of type string</span>
+
+ .requiredProperty(EpRequirements.anyProperty()) <span class="hljs-comment">// any field allowed (no restriction)</span>
+ .requiredProperty(EpRequirements.timestampReq()) <span class="hljs-comment">// any timestamp field</span>
+ .build())
+
+
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+ .outputStrategy(OutputStrategies.keep())
+
+ .build();
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="specifying-semantics"></a><a href="#specifying-semantics" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1 [...]
+<p>For some algorithms, only specifying the datatype is not sufficient. Let's consider a geofencing algorithm that detects the precense some geospatial coordinate (e.g., from a vehicle) within a given location.</p>
+<p>You could specify something like this:</p>
+<pre><code class="hljs css language-java"> StreamRequirementsBuilder
+ .create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.doubleEp(), Labels.from(<span class="hljs-string">"mapping-latitude"</span>, <span class="hljs-string">"Latitude"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .requiredPropertyWithUnaryMapping(EpRequirements.doubleEp(), Labels.from(<span class="hljs-string">"mapping-longitude"</span>, <span class="hljs-string">"Longitude"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .build()
+</code></pre>
+<p>However, this would allow users to create strange pipelines as users could connect any stream containing a double value to our geofencing algorithm.
+To avoid such situations, you can also specify requirements based on the semantics of a field:</p>
+<pre><code class="hljs css language-java"> StreamRequirementsBuilder
+ .create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.domainPropertyReq(SO.Latitude), Labels.from(<span class="hljs-string">"mapping-latitude"</span>, <span class="hljs-string">"Latitude"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .requiredPropertyWithUnaryMapping(EpRequirements.domainPropertyReq(SO.Longitude), Labels.from(<span class="hljs-string">"mapping-longitude"</span>, <span class="hljs-string">"Longitude"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .build()
+</code></pre>
+<p>Note that in this case, we make use of Schema.org's <code>Latitude</code> concept (<a href="https://schema.org/latitude">https://schema.org/latitude</a>). StreamPipes already includes popular vocabularies for specifying semantics. You are also free to use your own vocabularies.</p>
+<h2><a class="anchor" aria-hidden="true" id="requirements-on-lists"></a><a href="#requirements-on-lists" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2 [...]
+<p>Similarly to primitive requirements, you can define processors that require data streams with list fields, see the following examples:</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.requirements"</span> +
+ <span class="hljs-string">".list"</span>, <span class="hljs-string">"List requirements specification examples"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredProperty(EpRequirements.listRequirement(Datatypes.Integer))
+ .requiredProperty(EpRequirements.listRequirement(Datatypes.Double))
+ .requiredProperty(EpRequirements.listRequirement(Datatypes.Boolean))
+ .requiredProperty(EpRequirements.listRequirement(Datatypes.String))
+ .build())
+
+
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+ .outputStrategy(OutputStrategies.keep())
+
+ .build();
+ }
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="requirements-on-nested-properties"></a><a href="#requirements-on-nested-properties" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S1 [...]
+<p>(coming soon, see the Javadoc for now)</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-sdk-guide-sinks.html"><span class="arrow-prev">← </span><span>SDK Guide: Data Sinks</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-static-properties.html"><span>dev-guide-static-properties</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#introduction">Introduction</a></li>< [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-tutorial-processors.html b/docs/docs/0.70.0/dev-guide-tutorial-processors.html
new file mode 100644
index 00000000..28dd218d
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-tutorial-processors.html
@@ -0,0 +1,473 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Tutorial: Data Processors · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="In this tutorial, we will add a new data processor using the Apache Flink wrapper."/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" c [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Tutorial: Data Processors</h1></header><article><div><span><p>In this tutorial, we will add a new data processor using the Apache Flink wrapper.</p>
+<p>From an architectural point of view, we will create a self-contained service that includes the description of the data processor and a Flink-compatible implementation.
+Once a pipeline is started that uses this data processor, the implementation is submitted to an Apache Flink cluster.</p>
+<h2><a class="anchor" aria-hidden="true" id="objective"></a><a href="#objective" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>We are going to create a new data processor that realized a simple geofencing algorithm - we detect vehicles that enter a specified radius around a user-defined location.
+This pipeline element will be a generic element that works with any event stream that provides geospatial coordinates in form of a latitude/longitude pair.</p>
+<p>The algorithm outputs every location event once the position has entered the geofence.</p>
+<div class="admonition note">
+<div class="admonition-title">Note</div>
+<p>The implementation in this tutorial is pretty simple - our processor will fire an event every time the GPS location is inside the geofence.
+ In a real-world application, you would probably want to define a pattern that recognizes the _first_ event a vehicle enters the geofence.<br/>
+ This can be easily done using a CEP library, e.g., Apache Flink CEP.</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="project-setup"></a><a href="#project-setup" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>To create new projects from scratch, several Maven archetypes exist to start developing.
+Enter the following command to create a new project based on the StreamPipes <code>Processors-Flink</code> archetype:</p>
+<pre><code class="hljs">mvn archetype:generate <span class="hljs-attribute">-DarchetypeGroupId</span>=org.streampipes \
+<span class="hljs-attribute">-DarchetypeArtifactId</span>=streampipes-archetype-pe-processors-flink <span class="hljs-attribute">-DarchetypeVersion</span>=0.64.0 \
+<span class="hljs-attribute">-DgroupId</span>=org.streampipes.tutorial <span class="hljs-attribute">-DartifactId</span>=geofence-tutorial <span class="hljs-attribute">-DclassNamePrefix</span>=Geofencing <span class="hljs-attribute">-DpackageName</span>=geofencing
+</code></pre>
+<p>Once you've imported the generated project, the project structure should look as follows:</p>
+<p><img src="/docs/img/tutorial-processors/project-structure-processor.PNG" alt="Project Structure Data Processor"></p>
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p>Besides the basic project skeleton, the sample project also includes an example Dockerfile you can use to package your application into a Docker container.</p>
+</div>
+<p>Now you're ready to create your first data processor for StreamPipes!</p>
+<h2><a class="anchor" aria-hidden="true" id="adding-data-processor-requirements"></a><a href="#adding-data-processor-requirements" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5 [...]
+<p>First, we will add a new stream requirement.
+Open the class <code>GeofencingController</code> which should look as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">package</span> org.streampipes.tutorial.pe.processor.geofencing;
+
+<span class="hljs-keyword">import</span> org.streampipes.tutorial.config.Config;
+
+<span class="hljs-keyword">import</span> org.streampipes.model.DataProcessorType;
+<span class="hljs-keyword">import</span> org.streampipes.model.graph.DataProcessorDescription;
+<span class="hljs-keyword">import</span> org.streampipes.model.graph.DataProcessorInvocation;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.builder.ProcessingElementBuilder;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.builder.StreamRequirementsBuilder;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.extractor.ProcessingElementParameterExtractor;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.EpRequirements;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.Labels;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.OutputStrategies;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.SupportedFormats;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.SupportedProtocols;
+<span class="hljs-keyword">import</span> org.streampipes.wrapper.flink.FlinkDataProcessorDeclarer;
+<span class="hljs-keyword">import</span> org.streampipes.wrapper.flink.FlinkDataProcessorRuntime;
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">GeofencingController</span> <span class="hljs-keyword">extends</span>
+ <span class="hljs-title">FlinkDataProcessorDeclarer</span><<span class="hljs-title">GeofencingParameters</span>> </span>{
+
+ <span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> String EXAMPLE_KEY = <span class="hljs-string">"example-key"</span>;
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.tutorial-geofencing"</span>)
+ .category(DataProcessorType.ENRICH)
+ .withAssets(Assets.DOCUMENTATION, Assets.ICON)
+ .withLocales(Locales.EN)
+ .requiredStream(StreamRequirementsBuilder
+ .create()
+ .requiredProperty(EpRequirements.anyProperty())
+ .build())
+ .outputStrategy(OutputStrategies.keep())
+ .requiredTextParameter(Labels.from(EXAMPLE_KEY, <span class="hljs-string">"Example Text Parameter"</span>, <span class="hljs-string">"Example "</span> +
+ <span class="hljs-string">"Text Parameter Description"</span>))
+ .build();
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> FlinkDataProcessorRuntime<GeofencingParameters> <span class="hljs-title">getRuntime</span><span class="hljs-params">(DataProcessorInvocation
+ graph, ProcessingElementParameterExtractor extractor)</span> </span>{
+
+ String exampleString = extractor.singleValueParameter(EXAMPLE_KEY, String<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+
+ GeofencingParameters params = <span class="hljs-keyword">new</span> GeofencingParameters(graph, exampleString);
+
+ <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> GeofencingProgram(params, Config.INSTANCE.getDebug());
+ }
+
+}
+
+</code></pre>
+<p>In this class, we need to implement two methods: The <code>declareModel</code> method is used to define abstract stream requirements such as event properties that must be present in any input stream that is later connected to the element using the StreamPipes UI.
+The second method, <code>getRuntime</code> is used to create and deploy the parameterized Flink program once a pipeline using this element is started.</p>
+<p>Similar to data sources, the SDK provides a builder class to generate the description for data processors.
+Delete the content within the <code>declareModel</code> method and add the following lines to the <code>declareModel</code> method:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.tutorial.geofencing"</span>, <span class="hljs-string">"Geofencing"</span>, <span class="hljs-string">"A simple geofencing data processor "</span> +
+ <span class="hljs-string">"using the Apache Flink wrapper"</span>)
+</code></pre>
+<p>This creates a new data processor with the ID, title and description assigned to the element builder.
+Next, we add some <em>stream requirements</em> to the description. As we'd like to develop a generic pipeline element that works with any event that provides a lat/lng pair, we define two stream requirements as stated below:</p>
+<pre><code class="hljs css language-java">.requiredStream(StreamRequirementsBuilder
+ .create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.domainPropertyReq(Geo.lat),
+ Labels.from(<span class="hljs-string">"latitude-field"</span>, <span class="hljs-string">"Latitude"</span>, <span class="hljs-string">"The event "</span> +
+ <span class="hljs-string">"property containing the latitude value"</span>), PropertyScope.MEASUREMENT_PROPERTY)
+ .requiredPropertyWithUnaryMapping(EpRequirements.domainPropertyReq(Geo.lng),
+ Labels.from(<span class="hljs-string">"longitude-field"</span>, <span class="hljs-string">"Longitude"</span>, <span class="hljs-string">"The event "</span> +
+ <span class="hljs-string">"property containing the longitude value"</span>), PropertyScope.MEASUREMENT_PROPERTY)
+ .build())
+</code></pre>
+<p>The first line, <code>.requiredStream()</code> defines that we want a data processor with exactly one input stream. Adding more stream requirements would create elements with multiple input connectors in StreamPipes.
+Stream requirements can be assigned by using the <code>StreamRequirementsBuilder</code> class.
+In our example, we define two requirements, so-called <em>domain property requirements</em>. In contrast to <em>data type requirements</em> where we'd expect an event property with a field of a specific data type (e.g., float), domain property requirements expect a specific domain property, e.g., from a vocabulary such as the WGS84 Geo vocab.</p>
+<p>Once a pipeline is deployed, we are interested in the actual field (and its field name) that contains the latitude and longitude values.
+In some cases, there might me more than one field that satisfies a property requirement and we would like users to select the property the geofencing component should operate on.
+Therefore, our example uses the method <code>requiredPropertyWithUnaryMapping</code>, which will map a requirement to a real event property of an input stream and let the user choose the appropriate field in the StreamPipes UI when pipelines are defined.</p>
+<p>Finally, the <code>PropertyScope</code> indicates that the required property is a measurement value (in contrast to a dimension value). This allows us later to provide improved user guidance in the pipeline editor.</p>
+<p>Besides requirements, users should be able to define the center coordinate of the Geofence and the size of the fence defined as a radius around the center in meters.
+The radius can be defined by adding a simple required text field to the description:</p>
+<pre><code class="hljs css language-java">.requiredIntegerParameter(<span class="hljs-string">"radius"</span>, <span class="hljs-string">"Geofence Size"</span>, <span class="hljs-string">"The size of the circular geofence in meters."</span>, <span class="hljs-number">0</span>, <span class="hljs-number">1000</span>, <span class="hljs-number">1</span>)
+</code></pre>
+<p>Similar to mapping properties, text parameters have an internalId (radius), a label and a description.
+In addition, we can assign a <em>value specification</em> to the parameter indicating the value range we support.
+Our example supports a radius value between 0 and 1000 with a granularity of 1.
+In the StreamPipes UI, a required text parameter is rendered as a text input field, in case we provide an optional value specification, a slider input is automatically generated.</p>
+<p>Such user-defined parameters are called <em>static properties</em>. There are many different types of static properties (see the <a href="dev-guide-sdk-guide-processors#docsNav">Processor SDK</a> for an overview).</p>
+<p>One example are <em>DomainProperties</em> we use for defining the center of the geofence.
+Our data processor requires a lat/lng pair that marks the center of the geofence.
+However, letting users directly input latitude and longitude coordinates wouldn't be very user-friendly.
+Therefore, we can link required text parameters to <em>ontology concepts</em>. By understanding the required input, the StreamPipes UI is able to determine which user interface works best for a specific concept.</p>
+<p>Add the following line to the <code>declareModel</code> method:</p>
+<pre><code class="hljs css language-java">.requiredOntologyConcept(Labels.from(<span class="hljs-string">"location"</span>, <span class="hljs-string">"Geofence Center"</span>, <span class="hljs-string">"Provide the coordinate of the "</span> +
+ <span class="hljs-string">"geofence center"</span>), OntologyProperties.mandatory(Geo.lat), OntologyProperties.mandatory(Geo.lng))
+
+</code></pre>
+<p>We've now defined that we would like to receive an instance that provides a latitude and a longitude coordinate.
+Users can input these values either manually, or they can look up <em>domain knowledge</em>, i.e., knowledge stored isolated from the stream definition.</p>
+<p>Finally, we need to define technical requirements of the data processor, called <em>groundings</em>.
+StreamPipes supports various runtime data formats (e.g., JSON or Thrift) and various protocols (e.g., Kafka or JMS).
+Each component defines supports formats and protocol separately.
+For our example, we'd like to support JSON-based messages and Kafka as input and output broker protocol, so append the following:</p>
+<pre><code class="hljs css language-java">.supportedProtocols(SupportedProtocols.kafka())
+.supportedFormats(SupportedFormats.jsonFormat())
+.build();
+</code></pre>
+<p>Now we need to define the output of our Geofencing pipeline element.
+As explained in the first section, the element should fire every time some geo-located entity arrives within the defined geofence.
+Therefore, the processor outputs the same schema as it receives as an input.
+Although we don't know the exact input right now as it depends on the stream users connect in StreamPipes when creating pipelines, we can define an <em>output strategy</em> as follows:</p>
+<pre><code class="hljs css language-java">.outputStrategy(OutputStrategies.keep())
+</code></pre>
+<p>This defines a <em>KeepOutputStrategy</em>, i.e., the input event schema is not modified by the processor.
+There are many more output strategies you can define depending on the functionality you desire, e.g., <em>AppendOutput</em> for defining a processor that enriches events or <em>CustomOutput</em> in case you would like users to select the output by themselves.</p>
+<p>That's it! We've now defined input requirements, required user input, technical requirements concerned with data format and protocol and an output strategy.
+In the next section, you will learn how to extract these parameters once the pipeline element is invoked after a pipeline was created.</p>
+<h2><a class="anchor" aria-hidden="true" id="pipeline-element-invocation"></a><a href="#pipeline-element-invocation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 1 [...]
+<p>Once users start a pipeline that uses our geofencing component, the <em>getRuntime</em> method in our class is called. The class <code>DataSinkInovcation</code> includes a graph that contains information on the configuration parameters a users has selected in the pipeline editor and information on the acutal streams that are connected to the pipeline element.</p>
+<p>Before we explain in more detail how to extract these values from the processor invocation, we need to adapt a little helper class.
+Open the file <code>GeofencingParameters</code> and modify it as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">GeofencingParameters</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">EventProcessorBindingParams</span> </span>{
+
+ <span class="hljs-keyword">private</span> String latitudeFieldName;
+ <span class="hljs-keyword">private</span> String longitudeFieldName;
+
+ <span class="hljs-keyword">private</span> Float centerLatitude;
+ <span class="hljs-keyword">private</span> Float centerLongitude;
+
+ <span class="hljs-keyword">private</span> Integer radius;
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">GeofencingParameters</span><span class="hljs-params">(DataProcessorInvocation graph, String latitudeFieldName, String longitudeFieldName,
+ Float centerLatitude, Float centerLongitude, Integer radius)</span> </span>{
+ <span class="hljs-keyword">super</span>(graph);
+ <span class="hljs-keyword">this</span>.latitudeFieldName = latitudeFieldName;
+ <span class="hljs-keyword">this</span>.longitudeFieldName = longitudeFieldName;
+ <span class="hljs-keyword">this</span>.centerLatitude = centerLatitude;
+ <span class="hljs-keyword">this</span>.centerLongitude = centerLongitude;
+ <span class="hljs-keyword">this</span>.radius = radius;
+ }
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getLatitudeFieldName</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> latitudeFieldName;
+ }
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">getLongitudeFieldName</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> longitudeFieldName;
+ }
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> Float <span class="hljs-title">getCenterLatitude</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> centerLatitude;
+ }
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> Float <span class="hljs-title">getCenterLongitude</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> centerLongitude;
+ }
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> Integer <span class="hljs-title">getRadius</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> radius;
+ }
+</code></pre>
+<p>This simple Pojo class will later serve to store user-defined parameters in a single object.</p>
+<p>Now we go back to the controller class and extract these values from the invocation object.</p>
+<p>The <code>ProcessingElementParameterExtractor</code> provides convenience methods to extract the relevant information from the <code>DataProcessorInvocation</code> object.</p>
+<p>Next, we are interested in the fields of the input event stream that contains the latitude and longitude value we would like to compute against the geofence center location as follows:</p>
+<pre><code class="hljs css language-java">String latitudeFieldName = extractor.mappingPropertyValue(<span class="hljs-string">"latitude-field"</span>);
+String longitudeFieldName = extractor.mappingPropertyValue(<span class="hljs-string">"longitude-field"</span>);
+</code></pre>
+<p>We use the same <code>internalId</code> we've used to define the mapping property requirements in the <code>declareModel</code> method.</p>
+<p>Next, for extracting the geofence center coordinates, we use the following statements:</p>
+<pre><code class="hljs css language-java">Float centerLatitude = extractor.supportedOntologyPropertyValue(<span class="hljs-string">"location"</span>, Geo.lat, Float<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+Float centerLongitude = extractor.supportedOntologyPropertyValue(<span class="hljs-string">"location"</span>, Geo.lng, Float<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+</code></pre>
+<p>The radius value can be extracted as follows:</p>
+<pre><code class="hljs css language-java">Integer radius = extractor.singleValueParameter(<span class="hljs-string">"radius"</span>, Integer<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+</code></pre>
+<p>Now we can create a new instance of our previously created parameter class:</p>
+<pre><code class="hljs css language-java">GeofencingParameters params = <span class="hljs-keyword">new</span> GeofencingParameters(dataProcessorInvocation, latitudeFieldName,
+ longitudeFieldName, centerLatitude, centerLongitude, radius);
+</code></pre>
+<p>Finally, return an instance of the class <code>GeofencingProgram</code>:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> GeofencingProgram(params, <span class="hljs-keyword">true</span>);
+</code></pre>
+<div class="admonition tip">
+<div class="admonition-title">Info</div>
+<p>The line above uses the Flink MiniCluster to start the Flink program for debugging purposes.
+ Before you build the project and use it in a real environment, replace the line as follows, which triggers cluster execution:
+ <code>return new GeofencingProgram(params, new FlinkDeploymentConfig(Config.JAR_FILE, Config.INSTANCE.getFlinkHost(), Config.INSTANCE.getFlinkPort())</code></p>
+</div>
+<p>Great! That's all we need to describe a data processor for usage in StreamPipes. Your controller class should look as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">import</span> org.streampipes.model.graph.DataProcessorDescription;
+<span class="hljs-keyword">import</span> org.streampipes.model.graph.DataProcessorInvocation;
+<span class="hljs-keyword">import</span> org.streampipes.model.schema.PropertyScope;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.builder.ProcessingElementBuilder;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.builder.StreamRequirementsBuilder;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.extractor.ProcessingElementParameterExtractor;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.EpRequirements;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.Labels;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.OntologyProperties;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.OutputStrategies;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.SupportedFormats;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.SupportedProtocols;
+<span class="hljs-keyword">import</span> org.streampipes.vocabulary.Geo;
+<span class="hljs-keyword">import</span> org.streampipes.wrapper.flink.FlinkDataProcessorDeclarer;
+<span class="hljs-keyword">import</span> org.streampipes.wrapper.flink.FlinkDataProcessorRuntime;
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">GeofencingController</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">FlinkDataProcessorDeclarer</span><<span class="hljs-title">GeofencingParameters</span>> </span>{
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">protected</span> FlinkDataProcessorRuntime<GeofencingParameters> <span class="hljs-title">getRuntime</span><span class="hljs-params">(DataProcessorInvocation dataProcessorInvocation)</span> </span>{
+ ProcessingElementParameterExtractor extractor = ProcessingElementParameterExtractor.from(dataProcessorInvocation);
+
+ String latitudeFieldName = extractor.mappingPropertyValue(<span class="hljs-string">"latitude-field"</span>);
+ String longitudeFieldName = extractor.mappingPropertyValue(<span class="hljs-string">"longitude-field"</span>);
+
+ Float centerLatitude = extractor.supportedOntologyPropertyValue(<span class="hljs-string">"location"</span>, Geo.lat, Float<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+ Float centerLongitude = extractor.supportedOntologyPropertyValue(<span class="hljs-string">"location"</span>, Geo.lng, Float<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+
+ Integer radius = extractor.singleValueParameter(<span class="hljs-string">"radius"</span>, Integer<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+
+ GeofencingParameters params = <span class="hljs-keyword">new</span> GeofencingParameters(dataProcessorInvocation, latitudeFieldName,
+ longitudeFieldName, centerLatitude, centerLongitude, radius);
+
+ <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> GeofencingProgram(params);
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"geofencing-flink"</span>, <span class="hljs-string">"Geofencing"</span>, <span class="hljs-string">"A simple geofencing data processor "</span> +
+ <span class="hljs-string">"using the Apache Flink wrapper"</span>)
+ .requiredStream(StreamRequirementsBuilder
+ .create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.domainPropertyReq(Geo.lat),
+ Labels.from(<span class="hljs-string">"latitude-field"</span>, <span class="hljs-string">"Latitude"</span>, <span class="hljs-string">"The event "</span> +
+ <span class="hljs-string">"property containing the latitude value"</span>), PropertyScope.MEASUREMENT_PROPERTY)
+ .requiredPropertyWithUnaryMapping(EpRequirements.domainPropertyReq(Geo.lng),
+ Labels.from(<span class="hljs-string">"longitude-field"</span>, <span class="hljs-string">"Longitude"</span>, <span class="hljs-string">"The event "</span> +
+ <span class="hljs-string">"property containing the longitude value"</span>), PropertyScope.MEASUREMENT_PROPERTY)
+ .build())
+ .requiredIntegerParameter(<span class="hljs-string">"radius"</span>, <span class="hljs-string">"Geofence Size"</span>, <span class="hljs-string">"The size of the circular geofence in meters."</span>,
+ <span class="hljs-number">0</span>, <span class="hljs-number">1000</span>, <span class="hljs-number">1</span>)
+ .requiredOntologyConcept(Labels.from(<span class="hljs-string">"location"</span>, <span class="hljs-string">"Geofence Center"</span>, <span class="hljs-string">"Provide the coordinate of the "</span> +
+ <span class="hljs-string">"geofence center"</span>), OntologyProperties.mandatory(Geo.lat), OntologyProperties.mandatory(Geo.lng))
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+ .outputStrategy(OutputStrategies.keep())
+ .build();
+ }
+}
+
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="adding-an-implementation"></a><a href="#adding-an-implementation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-. [...]
+<p>Everything we need to do now is to add an implementation which does not differ from writing an Apache Flink topology.</p>
+<p>Open the class <code>GeofencingProcessor.java</code> and add the following piece of code, which realizes the Geofencing functionality:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">GeofencingProcessor</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">FlatMapFunction</span><<span class="hljs-title">Map</span><<span class="hljs-title">String</span>, <span class="hljs-title">Object</span>>, <span class="hljs-title">Map</span><<span class="hljs-title">String</s [...]
+
+ <span class="hljs-keyword">private</span> String latitudeFieldName;
+ <span class="hljs-keyword">private</span> String longitudeFieldName;
+
+ <span class="hljs-keyword">private</span> Float centerLatitude;
+ <span class="hljs-keyword">private</span> Float centerLongitude;
+
+ <span class="hljs-keyword">private</span> Integer radius;
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">GeofencingProcessor</span><span class="hljs-params">(String latitudeFieldName, String longitudeFieldName, Float centerLatitude, Float centerLongitude, Integer radius)</span> </span>{
+ <span class="hljs-keyword">this</span>.latitudeFieldName = latitudeFieldName;
+ <span class="hljs-keyword">this</span>.longitudeFieldName = longitudeFieldName;
+ <span class="hljs-keyword">this</span>.centerLatitude = centerLatitude;
+ <span class="hljs-keyword">this</span>.centerLongitude = centerLongitude;
+ <span class="hljs-keyword">this</span>.radius = radius;
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">flatMap</span><span class="hljs-params">(Event in, Collector<Event> out)</span> <span class="hljs-keyword">throws</span> Exception </span>{
+ Float latitude = in.getFieldBySelector(latitudeFieldName).getAsPrimitive().getAsFloat();
+ Float longitude = in.getFieldBySelector(longitudeFieldName).getAsPrimitive().getAsFloat();
+
+ Float distance = distFrom(latitude, longitude, centerLatitude, centerLongitude);
+
+ <span class="hljs-keyword">if</span> (distance <= radius) {
+ out.collect(in);
+ }
+ }
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> Float <span class="hljs-title">distFrom</span><span class="hljs-params">(<span class="hljs-keyword">float</span> lat1, <span class="hljs-keyword">float</span> lng1, <span class="hljs-keyword">float</span> lat2, <span class="hljs-keyword">float</span> lng2)</span> </span>{
+ <span class="hljs-keyword">double</span> earthRadius = <span class="hljs-number">6371000</span>;
+ <span class="hljs-keyword">double</span> dLat = Math.toRadians(lat2-lat1);
+ <span class="hljs-keyword">double</span> dLng = Math.toRadians(lng2-lng1);
+ <span class="hljs-keyword">double</span> a = Math.sin(dLat/<span class="hljs-number">2</span>) * Math.sin(dLat/<span class="hljs-number">2</span>) +
+ Math.cos(Math.toRadians(lat1)) * Math.cos(Math.toRadians(lat2)) *
+ Math.sin(dLng/<span class="hljs-number">2</span>) * Math.sin(dLng/<span class="hljs-number">2</span>);
+ <span class="hljs-keyword">double</span> c = <span class="hljs-number">2</span> * Math.atan2(Math.sqrt(a), Math.sqrt(<span class="hljs-number">1</span>-a));
+ <span class="hljs-keyword">return</span> (<span class="hljs-keyword">float</span>) (earthRadius * c);
+ }
+
+}
+</code></pre>
+<p>We won't go into details here as this isn't StreamPipes-related code, but in general the class extracts latitude and longitude fields from the input event (which is provided as a map data type) and calculates the distance between the geofence center and these coordinates.
+If the distance is below the given radius, the event is forwarded to the next operator.</p>
+<p>Finally, we need to connect this program to the Flink topology. StreamPipes automatically adds things like the Kafka consumer and producer, so that you only need to invoke the actual geofencing processor.
+Open the file <code>GeofencingProgram</code> and append the following line inside the <code>getApplicationLogic()</code> method:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">return</span> dataStreams[<span class="hljs-number">0</span>].flatMap(<span class="hljs-keyword">new</span> GeofencingProcessor(params.getLatitudeFieldName(), params.getLongitudeFieldName(),
+ params.getCenterLatitude(), params.getCenterLongitude(), params.getRadius()));
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="preparing-the-container"></a><a href="#preparing-the-container" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 [...]
+<p>The final step is to define the deployment type of our new data source. In this tutorial, we will create a so-called <code>StandaloneModelSubmitter</code>.
+This client will start an embedded web server that provides the description of our data source and automatically submits the program to the registered Apache Flink cluster.</p>
+<p>Go to the class <code>Init</code> that extends <code>StandaloneModelSubmitter</code> and should look as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">package</span> org.streampipes.tutorial.main;
+
+<span class="hljs-keyword">import</span> org.streampipes.container.init.DeclarersSingleton;
+<span class="hljs-keyword">import</span> org.streampipes.container.standalone.init.StandaloneModelSubmitter;
+
+<span class="hljs-keyword">import</span> org.streampipes.tutorial.config.Config;
+<span class="hljs-keyword">import</span> org.streampipes.tutorial.pe.processor.geofencing.GeofencingController;
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Init</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">StandaloneModelSubmitter</span> </span>{
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">main</span><span class="hljs-params">(String[] args)</span> <span class="hljs-keyword">throws</span> Exception </span>{
+ DeclarersSingleton.getInstance()
+ .add(<span class="hljs-keyword">new</span> GeofencingController());
+
+ <span class="hljs-keyword">new</span> Init().init(Config.INSTANCE);
+
+ }
+}
+</code></pre>
+<div class="admonition info">
+<div class="admonition-title">Info</div>
+<p>In the example above, we make use of a class `Config`.
+ This class contains both mandatory and additional configuration parameters required by a pipeline element container.
+ These values are stored in the Consul-based key-value store of your StreamPipes installation.
+ The SDK guide contains a detailed manual on managing container configurations.
+</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="starting-the-container"></a><a href="#starting-the-container" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0 [...]
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p>By default, the container registers itself using the hostname later used by the Docker container, leading to a 404 error when you try to access an RDF description.
+ For local development, we provide an environment file in the ``development`` folder. You can add your hostname here, which will override settings from the Config class.
+ For instance, use the IntelliJ ``EnvFile`` plugin to automatically provide the environment variables upon start.
+</p>
+</div>
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p> The default port of all pipeline element containers as defined in the `Config` file is port 8090.
+ If you'd like to run mutliple containers at the same time on your development machine, change the port in the environment file.
+</p>
+</div>
+<p>Now we are ready to start our container!</p>
+<p>Execute the main method in the class <code>Main</code> we've just created, open a web browser and navigate to <a href="http://localhost:8090">http://localhost:8090</a> (or the port you have assigned in the environment file).</p>
+<p>You should see something as follows:</p>
+<p><img src="/docs/img/tutorial-processors/pe-overview-flink.PNG" alt="Pipeline Element Container Overview (Flink)"></p>
+<p>Click on the link of the data source to see the RDF description of the pipeline element.</p>
+<p><img src="/docs/img/tutorial-processors/pe-rdf-geofencing.PNG" alt="Geofencing RDF description"></p>
+<p>The container automatically registers itself in the Consul installation of StreamPipes.
+To install the just created element, open the StreamPipes UI and follow the manual provided in the <a href="user-guide-installation">user guide</a>.</p>
+<h2><a class="anchor" aria-hidden="true" id="read-more"></a><a href="#read-more" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>Congratulations! You've just created your first data processor for StreamPipes.
+There are many more things to explore and data processors can be defined in much more detail using multiple wrappers.
+Follow our <a href="dev-guide-sdk-guide-processors">SDK guide</a> to see what's possible!</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-tutorial-sources.html"><span class="arrow-prev">← </span><span>dev-guide-tutorial-sources</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-tutorial-sinks.html"><span>dev-guide-tutorial-sinks</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#objective">Objective</a></li><li><a [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-tutorial-sinks.html b/docs/docs/0.70.0/dev-guide-tutorial-sinks.html
new file mode 100644
index 00000000..84025efa
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-tutorial-sinks.html
@@ -0,0 +1,277 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Tutorial: Data Sinks · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="In this tutorial, we will add a new data sink using the standalone wrapper."/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/ [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Tutorial: Data Sinks</h1></header><article><div><span><p>In this tutorial, we will add a new data sink using the standalone wrapper.</p>
+<p>From an architectural point of view, we will create a self-contained service that includes the description of the data sink and a corresponding implementation.</p>
+<h2><a class="anchor" aria-hidden="true" id="objective"></a><a href="#objective" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>We are going to create a new data sink that calls an external HTTP endpoint to forward data to an external service.</p>
+<p>For each incoming event, an external service is invoked using an HTTP POST request. In this example, we'll call an endpoint provided by <a href="https://requestbin.com/">RequestBin</a>.
+To setup your own endpoint, go to <a href="https://requestbin.com/">https://requestbin.com/</a> and click "Create a request bin". Copy the URL of the newly created endpoint.</p>
+<h2><a class="anchor" aria-hidden="true" id="project-setup"></a><a href="#project-setup" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>We'll create a new project using the provided sinks-standalone-jvm Maven archetype.
+Enter the following command to create a new project based on the StreamPipes <code>Sinks-JVM</code> archetype:</p>
+<pre><code class="hljs">mvn archetype:generate <span class="hljs-attribute">-DarchetypeGroupId</span>=org.streampipes \
+<span class="hljs-attribute">-DarchetypeArtifactId</span>=streampipes-archetype-pe-sinks-jvm <span class="hljs-attribute">-DarchetypeVersion</span>=0.64.0 \
+<span class="hljs-attribute">-DgroupId</span>=org.streampipes.tutorial <span class="hljs-attribute">-DartifactId</span>=sink-tutorial <span class="hljs-attribute">-DclassNamePrefix</span>=Rest <span class="hljs-attribute">-DpackageName</span>=geofencing
+</code></pre>
+<p>Once you've imported the generated project, the project structure should look as follows:</p>
+<p><img src="/docs/img/tutorial-sinks/project-structure-sinks.png" alt="Project Structure Data Sink"></p>
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p>Besides the basic project skeleton, the sample project also includes an example Dockerfile you can use to package your application into a Docker container.</p>
+</div>
+<p>Now you're ready to create your first data sink for StreamPipes!</p>
+<h2><a class="anchor" aria-hidden="true" id="adding-data-sink-requirements"></a><a href="#adding-data-sink-requirements" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 [...]
+<p>First, we will add a new stream requirement.
+Open the class <code>RestController</code> which should look as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">package</span> org.streampipes.tutorial.pe.sink.rest;
+
+<span class="hljs-keyword">import</span> org.streampipes.model.DataSinkType;
+<span class="hljs-keyword">import</span> org.streampipes.model.graph.DataSinkDescription;
+<span class="hljs-keyword">import</span> org.streampipes.model.graph.DataSinkInvocation;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.builder.DataSinkBuilder;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.builder.StreamRequirementsBuilder;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.extractor.DataSinkParameterExtractor;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.EpRequirements;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.Labels;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.SupportedFormats;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.SupportedProtocols;
+<span class="hljs-keyword">import</span> org.streampipes.wrapper.standalone.ConfiguredEventSink;
+<span class="hljs-keyword">import</span> org.streampipes.wrapper.standalone.declarer.StandaloneEventSinkDeclarer;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.*;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.utils.Assets;
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">RestController</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">StandaloneEventSinkDeclarer</span><<span class="hljs-title">RestParameters</span>> </span>{
+
+ <span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> String EXAMPLE_KEY = <span class="hljs-string">"example-key"</span>;
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataSinkDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> DataSinkBuilder.create(<span class="hljs-string">"org.streampipes.tutorial.pe.sink.rest"</span>)
+ .category(DataSinkType.NOTIFICATION)
+ .withAssets(Assets.DOCUMENTATION, Assets.ICON)
+ .withLocales(Locales.EN)
+ .requiredStream(StreamRequirementsBuilder
+ .create()
+ .requiredPropertyWithNaryMapping(EpRequirements.anyProperty(), Labels.withId(
+ <span class="hljs-string">"fields-to-send"</span>), PropertyScope.NONE)
+ .build())
+ .build();
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> ConfiguredEventSink<RestParameters> <span class="hljs-title">onInvocation</span><span class="hljs-params">(DataSinkInvocation graph, DataSinkParameterExtractor extractor)</span> </span>{
+
+ List<String> fieldsToSend = extractor.mappingPropertyValues(<span class="hljs-string">"fields-to-send"</span>);
+
+ RestParameters params = <span class="hljs-keyword">new</span> RestParameters(graph, fieldsToSend);
+
+ <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> ConfiguredEventSink<>(params, Rest::<span class="hljs-keyword">new</span>);
+ }
+
+}
+
+</code></pre>
+<p>In this class, we need to implement two methods: The <code>declareModel</code> method is used to define abstract stream requirements such as event properties that must be present in any input stream that is later connected to the element using the StreamPipes UI.
+The second method, <code>onInvocation</code> is used to create and deploy program once a pipeline using this sink is started.</p>
+<p>The <code>declareModel</code> method describes the properties of our data sink:</p>
+<ul>
+<li><code>category</code> defines a category for this sink.</li>
+<li><code>withAssets</code> denotes that we will provide an external documentation file and an icon, which can be found in the <code>resources</code> folder</li>
+<li><code>withLocales</code> defines that we will provide an external language file, also available in the <code>resources</code> folder</li>
+<li><code>requiredStream</code> defines requirements any input stream connected to this sink must provide. In this case, we do not have any specific requirements, we just forward all incoming events to the REST sink. However, we want to let the user display a list of available fields from the connected input event, where users can select a subset. This is defined by defining a Mapping from the empty requirement. This will later on render a selection dialog in the pipeline editor.</li>
+</ul>
+<p>The <code>onInvocation</code> method is called when a pipeline containing the sink is started. Once a pipeline is started, we would like to extract user-defined parameters.
+In this example, we simply extract the fields selected by users that should be forwarded to the REST sink. Finally, we return a new configured event sink containing the parameters.</p>
+<h2><a class="anchor" aria-hidden="true" id="pipeline-element-invocation"></a><a href="#pipeline-element-invocation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 1 [...]
+<p>Once users start a pipeline that uses our geofencing component, the <em>getRuntime</em> method in our class is called. The class <code>DataSinkInovcation</code> includes a graph that contains information on the configuration parameters a users has selected in the pipeline editor and information on the acutal streams that are connected to the pipeline element.</p>
+<p>Before we explain in more detail how to extract these values from the processor invocation, we need to adapt a little helper class.
+Open the file <code>RestParameters</code> and modify it as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">RestParameters</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">EventSinkBindingParams</span> </span>{
+
+ <span class="hljs-keyword">private</span> List<String> fieldsToSend;
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">RestParameters</span><span class="hljs-params">(DataSinkInvocation graph, List<String> fieldsToSend)</span> </span>{
+ <span class="hljs-keyword">super</span>(graph);
+ <span class="hljs-keyword">this</span>.fieldsToSend = fieldsToSend;
+ }
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> List<String> <span class="hljs-title">getFieldsToSend</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> fieldsToSend;
+ }
+}
+</code></pre>
+<p>This file will later provide information on the configured pipeline element.</p>
+<h2><a class="anchor" aria-hidden="true" id="adding-an-implementation"></a><a href="#adding-an-implementation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-. [...]
+<p>Now open the class <code>Rest</code> to add the proper implementation (i.e., the Rest call executed for every incoming event).</p>
+<p>Our final class should look as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> Logger LOG = LoggerFactory.getLogger(Rest<span class="hljs-class">.<span class="hljs-keyword">class</span>.<span class="hljs-title">getCanonicalName</span>())</span>;
+
+ <span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> String REST_ENDPOINT_URI = YOUR_REQUEST_BIN_URL;
+ <span class="hljs-keyword">private</span> List<String> fieldsToSend;
+ <span class="hljs-keyword">private</span> SpDataFormatDefinition dataFormatDefinition;
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">Rest</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">this</span>.dataFormatDefinition = <span class="hljs-keyword">new</span> JsonDataFormatDefinition();
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onInvocation</span><span class="hljs-params">(RestParameters parameters, EventSinkRuntimeContext runtimeContext)</span> </span>{
+ <span class="hljs-keyword">this</span>.fieldsToSend = parameters.getFieldsToSend();
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event)</span> </span>{
+ Map<String, Object> outEventMap = event.getSubset(fieldsToSend).getRaw();
+ <span class="hljs-keyword">try</span> {
+ String json = <span class="hljs-keyword">new</span> String(dataFormatDefinition.fromMap(outEventMap));
+ Request.Post(REST_ENDPOINT_URI).body(<span class="hljs-keyword">new</span> StringEntity(json, Charsets.UTF_8)).execute();
+ } <span class="hljs-keyword">catch</span> (SpRuntimeException e) {
+ LOG.error(<span class="hljs-string">"Could not parse incoming event"</span>);
+ } <span class="hljs-keyword">catch</span> (IOException e) {
+ LOG.error(<span class="hljs-string">"Could not reach endpoint at {}"</span>, REST_ENDPOINT_URI);
+ }
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onDetach</span><span class="hljs-params">()</span> </span>{
+
+ }
+</code></pre>
+<p>The only class variable you need to change right now is the REST_ENDPOINT_URL. Change this url to the URL provided by your request bin.
+We'll ignore the other class variables and the constructor for now. Important are three methods, <code>onInvocation</code>, <code>onEvent</code> and <code>onDetach</code>.</p>
+<p>The <code>onInvocation</code> method is called once a pipeline containing our REST data sink is started. The <code>onEvent</code> method is called for each incoming event. Finally, <code>onDetach</code> is called when a pipeline is stopped.</p>
+<p>In the <code>onInvocation</code> method, we can extract the selected fields to be forwarded to the REST endpoint.
+In the <code>ònEvent</code> method, we use a helper method to get a subset of the incoming event.
+Finally, we convert the resulting <code>Map</code> to a JSON string and call the endpoint.</p>
+<h2><a class="anchor" aria-hidden="true" id="preparing-the-container"></a><a href="#preparing-the-container" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 [...]
+<p>The final step is to define the deployment type of our new data source. In this tutorial, we will create a so-called <code>StandaloneModelSubmitter</code>.
+This client will start an embedded web server that provides the description of our data source and automatically starts the program in an embedded container.</p>
+<p>Go to the class <code>Init</code> that extends <code>StandaloneModelSubmitter</code> and should look as follows:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">main</span><span class="hljs-params">(String[] args)</span> <span class="hljs-keyword">throws</span> Exception </span>{
+ DeclarersSingleton.getInstance()
+ .add(<span class="hljs-keyword">new</span> RestController());
+
+ DeclarersSingleton.getInstance().setPort(Config.INSTANCE.getPort());
+ DeclarersSingleton.getInstance().setHostName(Config.INSTANCE.getHost());
+
+ DeclarersSingleton.getInstance().registerDataFormats(<span class="hljs-keyword">new</span> JsonDataFormatFactory(),
+ <span class="hljs-keyword">new</span> CborDataFormatFactory(),
+ <span class="hljs-keyword">new</span> SmileDataFormatFactory(),
+ <span class="hljs-keyword">new</span> FstDataFormatFactory());
+
+ DeclarersSingleton.getInstance().registerProtocols(<span class="hljs-keyword">new</span> SpKafkaProtocolFactory(),
+ <span class="hljs-keyword">new</span> SpJmsProtocolFactory());
+
+ <span class="hljs-keyword">new</span> Init().init(Config.INSTANCE);
+</code></pre>
+<div class="admonition info">
+<div class="admonition-title">Info</div>
+<p>In the example above, we make use of a class `Config`.
+ This class contains both mandatory and additional configuration parameters required by a pipeline element container.
+ These values are stored in the Consul-based key-value store of your StreamPipes installation.
+ The SDK guide contains a detailed manual on managing container configurations.
+</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="starting-the-container"></a><a href="#starting-the-container" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0 [...]
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p>By default, the container registers itself using the hostname later used by the Docker container, leading to a 404 error when you try to access an RDF description.
+ For local development, we provide an environment file in the ``development`` folder. You can add your hostname here, which will override settings from the Config class.
+ For instance, use the IntelliJ ``EnvFile`` plugin to automatically provide the environment variables upon start.
+</p>
+</div>
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p> The default port of all pipeline element containers as defined in the `Config` file is port 8090.
+ If you'd like to run mutliple containers at the same time on your development machine, change the port in the environment file.
+</p>
+</div>
+<p>Now we are ready to start our container!</p>
+<p>Execute the main method in the class <code>Main</code> we've just created.</p>
+<p>The container automatically registers itself in the Consul installation of StreamPipes.
+To install the just created element, open the StreamPipes UI and follow the manual provided in the <a href="user-guide-installation">user guide</a>.</p>
+<h2><a class="anchor" aria-hidden="true" id="read-more"></a><a href="#read-more" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>Congratulations! You've just created your first data sink for StreamPipes.
+There are many more things to explore and data sinks can be defined in much more detail using multiple wrappers.
+Follow our <a href="dev-guide-sdk-guide-sinks">SDK guide</a> to see what's possible!</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-tutorial-processors.html"><span class="arrow-prev">← </span><span>dev-guide-tutorial-processors</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-sdk-guide-sources.html"><span>SDK Guide: Data Sources</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#objective">Objective</a></li [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/dev-guide-tutorial-sources.html b/docs/docs/0.70.0/dev-guide-tutorial-sources.html
new file mode 100644
index 00000000..ac6545df
--- /dev/null
+++ b/docs/docs/0.70.0/dev-guide-tutorial-sources.html
@@ -0,0 +1,302 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Tutorial: Data Sources · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="In this tutorial, we will add a new data source consisting of a single data stream. The source will be provided as a standalone component (i.e., the description will be a [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Tutorial: Data Sources</h1></header><article><div><span><p>In this tutorial, we will add a new data source consisting of a single data stream. The source will be provided as a standalone component (i.e., the description will be accessible through an integrated web server).</p>
+<h2><a class="anchor" aria-hidden="true" id="objective"></a><a href="#objective" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>We are going to create a new data stream that is produced by a GPS sensor installed in a delivery vehicle.
+The sensor produces a continuous stream of events that contain the current timestamp, the current lat/lng position of the vehicle and the plate number of the vehicle.
+Events are published in a JSON format as follows:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">145838399</span>,
+ <span class="hljs-attr">"latitude"</span> : <span class="hljs-number">37.04</span>,
+ <span class="hljs-attr">"longitude"</span> : <span class="hljs-number">17.04</span>,
+ <span class="hljs-attr">"plateNumber"</span> : <span class="hljs-string">"KA-AB 123"</span>
+}
+</code></pre>
+<p>These events are published to a Kafka broker using the topic <code>org.streampipes.tutorial.vehicle</code>.</p>
+<p>In the following section, we show how to describe this stream in a form that allows you to import and use it in StreamPipes.</p>
+<h2><a class="anchor" aria-hidden="true" id="project-setup"></a><a href="#project-setup" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Instead of creating a new project from scratch, we recommend to use the Maven archetype to create a new project skeleton.
+Enter the following command in a command line of your choice (Apache Maven needs to be installed):</p>
+<pre><code class="hljs">mvn archetype:generate \
+<span class="hljs-attribute">-DarchetypeGroupId</span>=org.streampipes <span class="hljs-attribute">-DarchetypeArtifactId</span>=streampipes-archetype-pe-sources \
+<span class="hljs-attribute">-DarchetypeVersion</span>=0.65.0 <span class="hljs-attribute">-DgroupId</span>=my.groupId \
+<span class="hljs-attribute">-DartifactId</span>=my-source <span class="hljs-attribute">-DclassNamePrefix</span>=MySource <span class="hljs-attribute">-DpackageName</span>=mypackagename
+</code></pre>
+<p>Configure the variables <code>artifactId</code> (which will be the Maven artifactId), <code>classNamePrefix</code> (which will be the class name of your data stream) and <code>packageName</code>.</p>
+<p>For this tutorial, use <code>Vehicle</code> as <code>classNamePrefix</code>.</p>
+<p>Your project will look as follows:</p>
+<p><img src="/docs/img/tutorial-sources/project-structure.PNG" alt="Project Structure"></p>
+<p>That's it, go to the next section to learn how to create your first data stream!</p>
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p>Besides the basic project skeleton, the sample project also includes an example Dockerfile you can use to package your application into a Docker container.
+</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="adding-a-data-stream-description"></a><a href="#adding-a-data-stream-description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13. [...]
+<p>Now we will add a new data stream definition.
+First, open the class <code>VehicleStream</code> which should look as follows:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-keyword">package</span> my.groupId.pe.mypackagename;
+
+<span class="hljs-keyword">import</span> org.streampipes.model.SpDataStream;
+<span class="hljs-keyword">import</span> org.streampipes.model.graph.DataSourceDescription;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.builder.DataStreamBuilder;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.EpProperties;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.Formats;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.helpers.Protocols;
+<span class="hljs-keyword">import</span> org.streampipes.sources.AbstractAdapterIncludedStream;
+
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MySourceStream</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">AbstractAdapterIncludedStream</span> </span>{
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> SpDataStream <span class="hljs-title">declareModel</span><span class="hljs-params">(DataSourceDescription sep)</span> </span>{
+ <span class="hljs-keyword">return</span> DataStreamBuilder.create(<span class="hljs-string">"my.groupId-mypackagename"</span>, <span class="hljs-string">"MySource"</span>, <span class="hljs-string">""</span>)
+ .property(EpProperties.timestampProperty(<span class="hljs-string">"timestamp"</span>))
+
+ <span class="hljs-comment">// configure your stream here</span>
+
+ .format(Formats.jsonFormat())
+ .protocol(Protocols.kafka(<span class="hljs-string">"localhost"</span>, <span class="hljs-number">9092</span>, <span class="hljs-string">"TOPIC_SHOULD_BE_CHANGED"</span>))
+ .build();
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">executeStream</span><span class="hljs-params">()</span> </span>{
+
+ }
+}
+</code></pre>
+<p>This class extends the class <code>AbstractAdapterIncludedStream</code>, which indicates that this source continuously produces data (configured in the <code>executeStream()</code> method.
+In contrast, the class <code>AbstractAlreadyExistingStream</code> indicates that we only want to describe an already existing stream (e.g., a stream that already sends data to an existing Kafka broker).</p>
+<p>Next, we will add the definition of the data stream. Add the following code inside of the <code>declareModel</code> method:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">return</span> DataStreamBuilder.create(<span class="hljs-string">"org.streampipes.tutorial.vehicle.position"</span>, <span class="hljs-string">"Vehicle Position"</span>, <span class="hljs-string">"An event stream "</span> +
+ <span class="hljs-string">"that produces current vehicle positions"</span>)
+</code></pre>
+<p>This line creates a new instance of the SDK's <code>DataStreamBuilder</code> by providing three basic parameters:
+The first parameter must be a unique identifier of your data stream.
+The second and third parameters indicate a label and a description of your stream.
+These values will later be used in the StreamPipes UI to display stream details in a human-readable manner.</p>
+<p>Next, we will add the properties as stated above to the stream definition by adding the following lines:</p>
+<pre><code class="hljs css language-java">.property(EpProperties.timestampProperty(<span class="hljs-string">"timestamp"</span>))
+.property(EpProperties.stringEp(Labels.from(<span class="hljs-string">"plate-number"</span>, <span class="hljs-string">"Plate Number"</span>, <span class="hljs-string">"Denotes the plate number of the vehicle"</span>), <span class="hljs-string">"plateNumber"</span>, <span class="hljs-string">"http://my.company/plateNumber"</span>))
+.property(EpProperties.doubleEp(Labels.from(<span class="hljs-string">"latitude"</span>, <span class="hljs-string">"Latitude"</span>, <span class="hljs-string">"Denotes the latitude value of the vehicle's position"</span>), <span class="hljs-string">"latitude"</span>, Geo.lat))
+.property(EpProperties.doubleEp(Labels.from(<span class="hljs-string">"longitude"</span>, <span class="hljs-string">"Longitude"</span>, <span class="hljs-string">"Denotes the longitude value of the vehicle's position"</span>), <span class="hljs-string">"longitude"</span>, Geo.lng))
+</code></pre>
+<p>These four <em>event properties</em> compose our <em>event schema</em>. An event property must, at least, provide the following attributes:</p>
+<ul>
+<li><strong>Runtime Name</strong>. The runtime name indicates the key of the property at runtime, e.g., if our JSON message contains a structure such as <code>{"plateNumber" : "KA-F 123"}</code>, the runtime name must be <code>plateNumber</code>.</li>
+<li><strong>Runtime Type</strong>. An event property must have a primitive type (we will later see how to model more complex properties such as lists and nested properties).
+The type must be an instance of <code>XMLSchema</code> primitives, however, the SDK provides convenience methods to provide the property type.</li>
+<li><strong>Domain Property</strong>. The domain property indicates the semantics of the event property. For instance, the <code>latitude</code> property is linked to the <code>http://www.w3.org/2003/01/geo/wgs84_pos#lat</code> property of the WGS84 vocabulary.
+The domain property should be an URI as part of an existing or domain-specific vocabulary. The SDK provides convenience methods for popuplar vocabularies (e.g., Schema.org, Dolce or WGS84).</li>
+</ul>
+<p>In order to complete the minimum required specification of an event stream, we need to provide information on the transport format and protocol of the data stream at runtime.</p>
+<p>This can be achieved by extending the builder with the respective properties (which should already have been auto-generated):</p>
+<pre><code class="hljs css language-java">.format(Formats.jsonFormat())
+.protocol(Protocols.kafka(<span class="hljs-string">"localhost"</span>, <span class="hljs-number">9092</span>, <span class="hljs-string">"TOPIC_SHOULD_BE_CHANGED"</span>))
+.build();
+</code></pre>
+<p>Set <code>org.streampipes.tutorial.vehicle</code> as your new topic by replacing the term ``TOPIC_SHOULD_BE_CHANGED`.</p>
+<p>In this example, we defined that the data stream consists of events in a JSON format and that Kafka is used as a message broker to transmit events.
+The last build() method call triggers the construction of the RDF-based data stream definition.</p>
+<p>That's it! In the next section, we will connect the data stream to a source and inspect the generated RDF description.</p>
+<h2><a class="anchor" aria-hidden="true" id="creating-some-dummy-data"></a><a href="#creating-some-dummy-data" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-. [...]
+<p>Let's assume our stream should produce some random values that are sent to StreamPipes. We'll add a very simple data simulator to the <code>executeStream</code> method as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">executeStream</span><span class="hljs-params">()</span> </span>{
+
+ SpKafkaProducer producer = <span class="hljs-keyword">new</span> SpKafkaProducer(<span class="hljs-string">"localhost:9092"</span>, <span class="hljs-string">"TOPIC_SHOULD_BE_CHANGED"</span>);
+ Random random = <span class="hljs-keyword">new</span> Random();
+ Runnable runnable = <span class="hljs-keyword">new</span> Runnable() {
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">run</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">for</span> (;;) {
+ JsonObject jsonObject = <span class="hljs-keyword">new</span> JsonObject();
+ jsonObject.addProperty(<span class="hljs-string">"timestamp"</span>, System.currentTimeMillis());
+ jsonObject.addProperty(<span class="hljs-string">"plateNumber"</span>, <span class="hljs-string">"KA-FZ 1"</span>);
+ jsonObject.addProperty(<span class="hljs-string">"latitude"</span>, random.nextDouble());
+ jsonObject.addProperty(<span class="hljs-string">"longitude"</span>, random.nextDouble());
+
+ producer.publish(jsonObject.toString());
+
+ <span class="hljs-keyword">try</span> {
+ Thread.sleep(<span class="hljs-number">1000</span>);
+ } <span class="hljs-keyword">catch</span> (InterruptedException e) {
+ e.printStackTrace();
+ }
+
+ }
+ }
+ };
+
+ <span class="hljs-keyword">new</span> Thread(runnable).start();
+ }
+</code></pre>
+<p>Change the topic and the URL of your Kafka broker (as stated in the controller).</p>
+<h2><a class="anchor" aria-hidden="true" id="adding-a-source-description"></a><a href="#adding-a-source-description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 1 [...]
+<p>A data source can be seen like a container for a set of data streams. Usually, a data source includes events that are logically or physically connected.
+For instance, in our example we would add other streams produced by vehicle sensors (such as fuel consumption) to the same data source description.</p>
+<p>Open the class <code>DataSource</code> which should look as follows:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-keyword">package</span> my.groupId.pe.mypackagename;
+
+<span class="hljs-keyword">import</span> org.streampipes.container.declarer.DataStreamDeclarer;
+<span class="hljs-keyword">import</span> org.streampipes.container.declarer.SemanticEventProducerDeclarer;
+<span class="hljs-keyword">import</span> org.streampipes.model.graph.DataSourceDescription;
+<span class="hljs-keyword">import</span> org.streampipes.sdk.builder.DataSourceBuilder;
+
+<span class="hljs-keyword">import</span> java.util.Arrays;
+<span class="hljs-keyword">import</span> java.util.List;
+
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">DataSource</span> <span class="hljs-keyword">implements</span> <span class="hljs-title">SemanticEventProducerDeclarer</span> </span>{
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataSourceDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> DataSourceBuilder.create(<span class="hljs-string">"my.groupId.mypackagename.source"</span>, <span class="hljs-string">"MySource "</span> +
+ <span class="hljs-string">"Source"</span>, <span class="hljs-string">""</span>)
+ .build();
+ }
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> List<DataStreamDeclarer> <span class="hljs-title">getEventStreams</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> Arrays.asList(<span class="hljs-keyword">new</span> MySourceStream());
+ }
+}
+</code></pre>
+<p>First, we need to define the source. Similar to data streams, a source consists of an id, a human-readable name and a description.
+Replace the content defined in the <code>declareModel</code> method with the following code:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">return</span> DataSourceBuilder.create(<span class="hljs-string">"org.streampipes.tutorial.source.vehicle"</span>, <span class="hljs-string">"Vehicle Source"</span>, <span class="hljs-string">"A data source that "</span> +
+ <span class="hljs-string">"holds event streams produced by vehicles."</span>)
+ .build();
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="preparing-the-container"></a><a href="#preparing-the-container" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 [...]
+<p>The final step is to define the deployment type of our new data source. In this tutorial, we will create a so-called <code>StandaloneModelSubmitter</code>.
+This client will start an embedded web server that provides the description of our data source.</p>
+<p>Go to the class <code>Init</code> that implements <code>StandaloneModelSubmitter</code>, which should look as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">package</span> my.groupId.main;
+
+<span class="hljs-keyword">import</span> org.streampipes.container.init.DeclarersSingleton;
+<span class="hljs-keyword">import</span> org.streampipes.container.standalone.init.StandaloneModelSubmitter;
+<span class="hljs-keyword">import</span> my.groupId.config.Config;
+<span class="hljs-keyword">import</span> my.groupId.pe.mypackagename.DataSource;
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Init</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">StandaloneModelSubmitter</span> </span>{
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">main</span><span class="hljs-params">(String[] args)</span> <span class="hljs-keyword">throws</span> Exception </span>{
+ DeclarersSingleton.getInstance()
+ .add(<span class="hljs-keyword">new</span> DataSource());
+
+ <span class="hljs-keyword">new</span> Init().init(Config.INSTANCE);
+
+ }
+}
+</code></pre>
+<p>This code adds the <code>VehicleSource</code>. Finally, the <code>init</code> method is called
+which triggers the generation of the corresponding RDF description and startup of the web server.</p>
+<div class="admonition info">
+<div class="admonition-title">Info</div>
+<p>In the example above, we make use of a class `Config`.
+ This class contains both mandatory and additional configuration parameters required by a pipeline element container.
+ These values are stored in the Consul-based key-value store of your StreamPipes installation.
+ The SDK guide contains a detailed manual on managing container configurations.</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="starting-the-container"></a><a href="#starting-the-container" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0 [...]
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p>By default, the container registers itself using the hostname later used by the Docker container, leading to a 404 error when you try to access an RDF description.
+ For local development, we provide an environment file in the ``development`` folder. You can add your hostname here, which will override settings from the Config class.
+ For instance, use the IntelliJ ``EnvFile`` plugin to automatically provide the environment variables upon start.
+</p>
+</div>
+<p>Now we are ready to start our first container!</p>
+<p>Execute the main method in the class <code>Main</code> we've just created, open a web browser and navigate to <a href="http://localhost:8090">http://localhost:8090</a>, or change the port according to the value of the <code>SP_PORT</code> variable in the env file.</p>
+<p>You should see something as follows:</p>
+<p><img src="/docs/img/tutorial-sources/pe-overview.PNG" alt="Pipeline Element Container Overview"></p>
+<p>Click on the link of the data source to see the RDF description of the pipeline element.</p>
+<p><img src="/docs/img/tutorial-sources/pe-rdf.PNG" alt="Pipeline Element RDF description"></p>
+<p>The container automatically registers itself in the Consul installation of StreamPipes.
+To install the just created element, open the StreamPipes UI and follow the manual provided in the <a href="user-guide-introduction">user guide</a>.</p>
+<h2><a class="anchor" aria-hidden="true" id="read-more"></a><a href="#read-more" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>Congratulations! You've just created your first pipeline element for StreamPipes.
+There are many more things to explore and data sources can be defined in much more detail.
+Follow our <a href="dev-guide-source-sdk">SDK guide</a> to see what's possible!</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/dev-guide-migration.html"><span class="arrow-prev">← </span><span>Migration Guide</span></a><a class="docs-next button" href="/docs/docs/0.70.0/dev-guide-tutorial-processors.html"><span>dev-guide-tutorial-processors</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#objective">Objective</a></li><li><a href="#p [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/extend-archetypes.html b/docs/docs/0.70.0/extend-archetypes.html
new file mode 100644
index 00000000..15e48ddf
--- /dev/null
+++ b/docs/docs/0.70.0/extend-archetypes.html
@@ -0,0 +1,124 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Maven Archetypes · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="In this tutorial we explain how you can use the Maven archetypes to develop your own StreamPipes processors and sinks."/><meta name="docsearch:version" content="0.70.0"/><meta [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Maven Archetypes</h1></header><article><div><span><p>In this tutorial we explain how you can use the Maven archetypes to develop your own StreamPipes processors and sinks.
+We use IntelliJ in this tutorial, but it works with any IDE of your choice.</p>
+<h2><a class="anchor" aria-hidden="true" id="prerequisites"></a><a href="#prerequisites" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>You need to have Maven installed, further you need an up and running StreamPipes installation on your development computer.</p>
+<h2><a class="anchor" aria-hidden="true" id="create-project"></a><a href="#create-project" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>To create a new project, we provide multiple Maven Archteypes.
+Currently, we provide archetypes for standalone Java-based microservices and archetypes for the experimental Flink wrapper.
+The commands required to create a new pipeline element project can be found below. Make sure that you select a version compatible with your StreamPipes installation.
+Copy the command into your terminal to create a new project.
+The project will be created in the current folder.
+First, the <code>groupId</code> of the resulting Maven artifact must be set.
+We use <code>groupId</code>: <code>org.example</code> and <code>artifactId</code>: <code>ExampleProcessor</code>.
+You can keep the default values for the other settings, confirm them by hitting enter.</p>
+<p>The current {sp.version} is 0.69.0 (for a pre-release version, use the SNAPSHOT appendix, e.g. 0.69.0-SNAPSHOT)</p>
+<pre><code class="hljs css language-bash">mvn archetype:generate \
+ -DarchetypeGroupId=org.apache.streampipes \
+ -DarchetypeArtifactId=streampipes-archetype-extensions-jvm \
+ -DarchetypeVersion={sp.version}
+</code></pre>
+<p><details class="info">
+<summary>Other archetypes</summary></p>
+<h2><a class="anchor" aria-hidden="true" id="processors-flink"></a><a href="#processors-flink" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
+<pre><code class="hljs css language-bash">mvn archetype:generate \
+ -DarchetypeGroupId=org.apache.streampipes \
+ -DarchetypeArtifactId=streampipes-archetype-pe-processors-flink \
+ -DarchetypeVersion={sp.version}
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="sinks-flink"></a><a href="#sinks-flink" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<pre><code class="hljs css language-bash">mvn archetype:generate \
+ -DarchetypeGroupId=org.apache.streampipes \
+ -DarchetypeArtifactId=streampipes-archetype-pe-sinks-flink \
+ -DarchetypeVersion={sp.version}
+</code></pre>
+<p></details></p>
+<h2><a class="anchor" aria-hidden="true" id="project-structure"></a><a href="#project-structure" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2- [...]
+<p>Open the project in your IDE.
+If everything worked, the structure should look similar to the following image.
+In the <em>main</em> package, it is defined which processors / sinks you want to activate and the <em>pe.example</em> package contains two skeletons for creating a data processor and sink.
+For details, have a look at the other parts of the Developer Guide, where these classes are explained in more depth.</p>
+<p><img src="/docs/img/archetype/project_structure.png" width="30%" alt="Project Structure"></p>
+<h2><a class="anchor" aria-hidden="true" id="next-steps"></a><a href="#next-steps" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1 [...]
+<p>Click <a href="/docs/docs/0.70.0/extend-first-processor.html">here</a> to learn how to create your first data processor.</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/extend-cli.html"><span class="arrow-prev">← </span><span class="function-name-prevnext">StreamPipes CLI</span></a><a class="docs-next button" href="/docs/docs/0.70.0/extend-first-processor.html"><span>Your first data processor</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#prerequisites">Prerequisites</a>< [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/extend-cli.html b/docs/docs/0.70.0/extend-cli.html
new file mode 100644
index 00000000..76d50103
--- /dev/null
+++ b/docs/docs/0.70.0/extend-cli.html
@@ -0,0 +1,227 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>StreamPipes CLI · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="The StreamPipes command-line interface (CLI) is focused on developers in order to provide an easy entrypoint to set up a suitable dev environment, either planning on developing" [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">StreamPipes CLI</h1></header><article><div><span><p>The StreamPipes command-line interface (CLI) is focused on developers in order to provide an easy entrypoint to set up a suitable dev environment, either planning on developing</p>
+<ul>
+<li>new extensions such as <strong>connect adapters, processors, sinks</strong> or,</li>
+<li>new core features for <strong>backend</strong> and <strong>ui</strong>.</li>
+</ul>
+<p>The main difference between the standard Docker/K8s installation is an improved communication between services running as containers and services running locally for development.</p>
+<p>The CLI can be found in the <a href="https://github.com/apache/incubator-streampipes/tree/master/installer/cli">main repository</a> or in the <code>compose/cli</code> folder of the downloaded source code.</p>
+<h2><a class="anchor" aria-hidden="true" id="tldr"></a><a href="#tldr" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6 [...]
+<pre><code class="hljs css language-bash">streampipes env --list
+[INFO] Available StreamPipes environment templates:
+pipeline-element
+...
+streampipes env --<span class="hljs-built_in">set</span> pipeline-element
+streampipes up -d
+</code></pre>
+<blockquote>
+<p><strong>NOTE</strong>: use <code>./streampipes</code> if you haven't add it to the PATH and sourced it (see section "Run <code>streampipes</code> from anywhere?").</p>
+</blockquote>
+<h2><a class="anchor" aria-hidden="true" id="prerequisites"></a><a href="#prerequisites" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>The CLI is basically a wrapper around multiple <code>docker</code> and <code>docker-compose</code> commands plus some additional sugar.</p>
+<ul>
+<li>Docker >= 17.06.0</li>
+<li>Docker-Compose >= 1.26.0 (Compose file format: 3.4)</li>
+<li>Google Chrome (recommended), Mozilla Firefox, Microsoft Edge</li>
+<li>For Windows Developer: GitBash only</li>
+</ul>
+<p>Tested on: <strong>macOS</strong>, <strong>Linux</strong>, <strong>Windows</strong>*)</p>
+<blockquote>
+<p><strong>NOTE</strong>: *) If you're using Windows the CLI only works in combination with GitBash - CMD, PowerShell won't work.</p>
+</blockquote>
+<h2><a class="anchor" aria-hidden="true" id="cli-commands-overview"></a><a href="#cli-commands-overview" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2 [...]
+<pre><code class="hljs">StreamPipes CLI - Manage your StreamPipes environment with ease
+
+Usage: streampipes COMMAND [OPTIONS]
+
+Options:
+ --help, -h show help
+ --version, -v show version
+
+Commands:
+ clean <span class="hljs-builtin-name">Remove</span> StreamPipes data volumes, dangling images <span class="hljs-keyword">and</span><span class="hljs-built_in"> network
+</span> down Stop <span class="hljs-keyword">and</span> <span class="hljs-builtin-name">remove</span> StreamPipes containers
+ env Inspect <span class="hljs-keyword">and</span> select StreamPipes environments
+ <span class="hljs-builtin-name">info</span> <span class="hljs-builtin-name">Get</span> information
+ logs <span class="hljs-builtin-name">Get</span> container logs <span class="hljs-keyword">for</span> specific container
+ ps List all StreamPipes container <span class="hljs-keyword">for</span> running environment
+ pull Download latest images <span class="hljs-keyword">from</span> Dockerhub
+ restart Restart StreamPipes environment
+ up Create <span class="hljs-keyword">and</span> start StreamPipes container environment
+
+<span class="hljs-builtin-name">Run</span> <span class="hljs-string">'streampipes COMMAND --help'</span> <span class="hljs-keyword">for</span> more <span class="hljs-builtin-name">info</span> on a command.
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="usage-along-dev-life-cycle"></a><a href="#usage-along-dev-life-cycle" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H [...]
+<p><strong>List</strong> available environment templates.</p>
+<pre><code class="hljs css language-bash">streampipes env --list
+</code></pre>
+<p><strong>Inspect</strong> services in an available environment to know what kind of services it is composed of.</p>
+<pre><code class="hljs css language-bash">streampipes env --inspect pipeline-element
+</code></pre>
+<p><strong>Set</strong> environment, e.g. <code>pipeline-element</code>, if you want to write a new pipeline element.</p>
+<pre><code class="hljs css language-bash">streampipes env --<span class="hljs-built_in">set</span> pipeline-element
+</code></pre>
+<p><strong>Start</strong> environment ( default: <code>dev</code> mode). Here the service definition in the selected environment is used to start the multi-container landscape.</p>
+<blockquote>
+<p><strong>NOTE</strong>: <code>dev</code> mode is enabled by default since we rely on open ports to core service such as <code>consul</code>, <code>couchdb</code>, <code>kafka</code> etc. to reach from the IDE when developing. If you don't want to map ports (except the UI port), then use the <code>--no-ports</code> flag.</p>
+</blockquote>
+<pre><code class="hljs css language-bash">streampipes up -d
+<span class="hljs-comment"># start in production mode with unmapped ports</span>
+<span class="hljs-comment"># streampipes up -d --no-ports</span>
+</code></pre>
+<p>Now you're good to go to write your new pipeline element :tada: :tada: :tada:</p>
+<blockquote>
+<p><strong>HINT for extensions</strong>: Use our <a href="https://streampipes.apache.org/docs/docs/dev-guide-archetype/">Maven archetypes</a> to setup a project skeleton and use your IDE of choice for development. However, we do recommend using IntelliJ.</p>
+</blockquote>
+<blockquote>
+<p><strong>HINT for core</strong>: To work on <code>backend</code> or <code>ui</code> features you need to set the template to <code>backend</code> and clone the core repository <a href="https://github.com/apache/incubator-streampipes">incubator-streampipes</a> - check the prerequisites there for more information.</p>
+</blockquote>
+<p><strong>Stop</strong> environment and remove docker container</p>
+<pre><code class="hljs css language-bash">streampipes down
+<span class="hljs-comment"># want to also clean docker data volumes when stopping the environment?</span>
+<span class="hljs-comment"># streampipes down -v</span>
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="additionally-useful-commands"></a><a href="#additionally-useful-commands" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 [...]
+<p><strong>Start individual services only?</strong> We got you! You chose a template that suits your needs and now you only want to start individual services from it, e.g. only Kafka and Consul.</p>
+<blockquote>
+<p><strong>NOTE</strong>: the service names need to be present and match your current <code>.spenv</code> environment.</p>
+</blockquote>
+<pre><code class="hljs css language-bash">streampipes up -d kafka consul
+</code></pre>
+<p><strong>Get current environment</strong> (if previously set using <code>streampipes env --set <environment></code>).</p>
+<pre><code class="hljs css language-bash">streampipes env
+</code></pre>
+<p><strong>Get logs</strong> of specific service and use optional <code>--follow</code> flag to stay attached to the logs.</p>
+<pre><code class="hljs css language-bash">streampipes logs --follow backend
+</code></pre>
+<p><strong>Update</strong> all services of current environment</p>
+<pre><code class="hljs css language-bash">streampipes pull
+</code></pre>
+<p><strong>Restart</strong> all services of current environment or specific services</p>
+<pre><code class="hljs css language-bash">streampipes restart
+<span class="hljs-comment"># restart backend & consul</span>
+<span class="hljs-comment"># streampipes restart backend consul</span>
+</code></pre>
+<p><strong>Clean</strong> your system and remove created StreamPipes Docker volumes, StreamPipes docker network and dangling StreamPipes images of old image layers.</p>
+<pre><code class="hljs css language-bash">streampipes clean
+<span class="hljs-comment"># remove volumes, network and dangling images</span>
+<span class="hljs-comment"># streampipes clean --volumes</span>
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="modifycreate-an-environment-template"></a><a href="#modifycreate-an-environment-template" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 [...]
+<p>As of now, this step has to be done <strong>manually</strong>. All environments are located in <code>environments/</code>.</p>
+<pre><code class="hljs css language-bash">├── adapter <span class="hljs-comment"># developing a new connect adapter</span>
+├── backend <span class="hljs-comment"># developing core backend features</span>
+├── basic <span class="hljs-comment"># wanna run core, UI, connect etc from the IDE?</span>
+├── full <span class="hljs-comment"># full version containing more pipeline elements</span>
+├── lite <span class="hljs-comment"># few pipeline elements, less memory </span>
+├── pipeline-element <span class="hljs-comment"># developing new pipeline-elements</span>
+└── ui <span class="hljs-comment"># developing UI features</span>
+</code></pre>
+<p><strong>Modifying an existing environment template</strong>. To modify an existing template, you can simply add a <code><YOUR_NEW_SERVICE></code> to the template.</p>
+<blockquote>
+<p><strong>NOTE</strong>: You need to make sure, that the service your are adding exists in <code>deploy/standalone/service/<YOUR_NEW_SERVICE></code>. If your're adding a completely new service take a look at existing ones, create a new service directory and include a <code>docker-compose.yml</code> and <code>docker-compose.dev.yml</code> file.</p>
+</blockquote>
+<pre><code class="hljs">[environment:backend]
+activemq
+kafka
+...
+<<span class="hljs-symbol">YOUR_NEW_SERVICE</span>>
+</code></pre>
+<p><strong>Creating a new</strong> environment template. To create a new environment template, place a new file <code>environments/<YOUR_NEW_ENVIRONMENT></code> in the template directory. Open the file and use the following schema.</p>
+<blockquote>
+<p><strong>IMPORTANT</strong>: Please make sure to have <code>[environment:<YOUR_NEW_ENVIRONMENT>]</code> header in the first line of your new template matching the name of the file. Make sure to use small caps letters (lowercase) only.</p>
+</blockquote>
+<pre><code class="hljs">[environmen<span class="hljs-variable">t:</span><span class="hljs-symbol"><YOUR_NEW_ENVIRONMENT></span>]
+<span class="hljs-symbol"><SERVICE_1></span>
+<span class="hljs-symbol"><SERVICE_2></span>
+...
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="run-streampipes-from-anywhere-no-problem"></a><a href="#run-streampipes-from-anywhere-no-problem" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 [...]
+<p>Simply add the path to this cli directory to your <code>$PATH</code> (on macOS, Linux) variable, e.g. in your <code>.bashrc</code> or <code>.zshrc</code>, or <code>%PATH%</code> (on Windows).</p>
+<p>For <strong>macOS</strong>, or <strong>Linux</strong>:</p>
+<pre><code class="hljs css language-bash"><span class="hljs-built_in">export</span> PATH=<span class="hljs-string">"/path/to/incubator-streampipes-installer/cli:<span class="hljs-variable">$PATH</span>"</span>
+</code></pre>
+<p>For <strong>Windows 10</strong>, e.g. check this <a href="https://helpdeskgeek.com/windows-10/add-windows-path-environment-variable/">documentation</a>.</p>
+<h2><a class="anchor" aria-hidden="true" id="upgrade-to-new-version"></a><a href="#upgrade-to-new-version" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0 [...]
+<p>To upgrade to a new version, simply edit the version tag <code>SP_VERSION</code> in the <code>.env</code> file.</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/extend-setup.html"><span class="arrow-prev">← </span><span>Development Setup</span></a><a class="docs-next button" href="/docs/docs/0.70.0/extend-archetypes.html"><span>Maven Archetypes</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#tldr">TL;DR</a></li><li><a href="#prerequisites">Prerequisites</a></li><li [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/extend-first-processor.html b/docs/docs/0.70.0/extend-first-processor.html
new file mode 100644
index 00000000..c76090df
--- /dev/null
+++ b/docs/docs/0.70.0/extend-first-processor.html
@@ -0,0 +1,119 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Your first data processor · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="In this section, we will explain how to start a pipeline element service and install it using the StreamPipes UI."/><meta name="docsearch:version" content="0.70.0"/><m [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Your first data processor</h1></header><article><div><span><p>In this section, we will explain how to start a pipeline element service and install it using the StreamPipes UI.</p>
+<p>Open the class <em>ExampleDataProcessor</em> and edit the <code>onEvent</code> method to print the incoming event, log it to the console and send it to the next component without changing it.</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event, SpOutputCollector collector)</span> </span>{
+ <span class="hljs-comment">// Print the incoming event on the console</span>
+ System.out.println(event);
+
+ <span class="hljs-comment">// Hand the incoming event to the output collector without changing it.</span>
+ collector.collect(event);
+}
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="start-processor"></a><a href="#start-processor" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 [...]
+<p>Starting from StreamPipes 0.69.0, the IP address of an extensions service (processor, adapter or sink) will be auto-discovered upon start.
+The auto-discovery is done by the StreamPipes service discovery mechanism and should work for most setups.
+Once you start an extensions service, you will see the chosen IP in printed in the console. Make sure that this IP does not point to localhost (127.0.0.1).
+If you see such an IP or the extensions service complains that it cannot resolve the IP, you can manually set the IP address of the extensions service. You can do so by providing an <code>SP_HOST</code> environment variable.</p>
+<p>To check if the service is up and running, open the browser on <em>'localhost:8090'</em> (or the port defined in the service definition). The machine-readable description of the processor should be visible as shown below.</p>
+<p><img src="/docs/img/archetype/endpoint.png" width="90%" alt="Project Structure"></p>
+<div class="admonition error">
+<div class="admonition-title">Common Problems</div>
+<p>
+If the service description is not shown on 'localhost:8090', you might have to change the port address.
+This needs to be done in the configuration of your service, further explained in the configurations part of the developer guide.
+<p>If the service does not show up in the StreamPipes installation menu, click on 'MANAGE ENDPOINTS' and add 'http://<span></span>YOUR_IP_OR_DNS_NAME:8090'.
+Use the IP or DNS name you provided as the SP_HOST variable or the IP (if resolvable) found by the auto-discovery service printed in the console.
+After adding the endpoint, a new processor with the name <em>Example</em> should show up.</p>
+</p>
+</div>
+<p>Now you can go to StreamPipes.
+Your new processor <em>'Example'</em> should now show up in the installation menu ("Install Pipeline Elements" in the left navigation bar).
+Install it, then switch to the pipeline view and create a simple pipeline that makes use of your newly created processor.
+In case you opened the StreamPipes installation for the first time, it should have been automatically installed during the setup process.</p>
+<p><img src="/docs/img/archetype/example_pipeline.png" width="80%" alt="Project Structure"></p>
+<p>Start this pipeline.
+Now you should see logging messages in your console and, once you've created a visualization, you can also see the resulting events of your component in StreamPipes.</p>
+<p>Congratulations, you have just created your first processor!
+From here on you can start experimenting and implement your own algorithms.</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/extend-archetypes.html"><span class="arrow-prev">← </span><span>Maven Archetypes</span></a><a class="docs-next button" href="/docs/docs/0.70.0/extend-tutorial-data-sources.html"><span>Tutorial: Data Sources</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#start-processor">Start Processor</a></li></ul></nav>< [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/extend-sdk-event-model.html b/docs/docs/0.70.0/extend-sdk-event-model.html
new file mode 100644
index 00000000..4a92d976
--- /dev/null
+++ b/docs/docs/0.70.0/extend-sdk-event-model.html
@@ -0,0 +1,175 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SDK Guide: Event Model · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Introduction"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="SDK Guide: Event Model [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">SDK Guide: Event Model</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="introduction"></a><a href="#introduction" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule= [...]
+<p>This guide explains the usage of the event model to manipulate runtime events for data processors and data sink.</p>
+<h2><a class="anchor" aria-hidden="true" id="prerequisites"></a><a href="#prerequisites" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>This guide assumes that you are already familiar with the basic setup of <a href="/docs/docs/0.70.0/dev-guide-sdk-guide-processors.html">data processors</a> and <a href="/docs/docs/0.70.0/dev-guide-sdk-guide-sinks.html">data sinks</a>.</p>
+<h3><a class="anchor" aria-hidden="true" id="property-selectors"></a><a href="#property-selectors" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22- [...]
+<p>In most cases, fields that are subject to be transformed by pipeline elements are provided by the assigned <code>MappingProperty</code> (see the guide on <a href="/docs/docs/0.70.0/dev-guide-static-properties.html">static properties</a>).</p>
+<p>Mapping properties return a <code>PropertySelector</code> that identifies a field based on (i) the <strong>streamIndex</strong> and (ii) the runtime name of the field.
+Let's assume we have an event with the following structure:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temperature"</span> : <span class="hljs-number">37.0</span>,
+ <span class="hljs-attr">"deviceId"</span> : <span class="hljs-string">"sensor1"</span>,
+ <span class="hljs-attr">"running"</span> : <span class="hljs-literal">true</span>,
+ <span class="hljs-attr">"location"</span> : {<span class="hljs-attr">"latitude"</span> : <span class="hljs-number">34.4</span>, <span class="hljs-attr">"longitude"</span> : <span class="hljs-number">-47</span>},
+ <span class="hljs-attr">"lastValues"</span> : [<span class="hljs-number">45</span>, <span class="hljs-number">22</span>, <span class="hljs-number">21</span>]
+}
+</code></pre>
+<p>In addition, we assume that a data processor exists (with one input node) that converts the temperature value (measured in degrees celsius) to a degree fahrenheit value.
+In this case, a mapping property (selected by the pipeline developer in the StreamPipes UI) would link to the <code>temperature</code> field of the event.</p>
+<p>The mapping property value will be the <code>PropertySelector</code> of the temperature value, which looks as follows:</p>
+<pre><code class="hljs">s0::temperature
+</code></pre>
+<p><code>s0</code> identifies the stream (in this case, only one input streams exist, but as data processors might require more than one input stream, a stream identifier is required), while the appendix identifies the runtime name.</p>
+<p>Note: If you add a new field to an input event, you don't need to provide the selector, you can just assign the runtime name as defined by the <a href="/docs/docs/0.70.0/dev-guide-output-strategies.html">output strategy</a>.</p>
+<h3><a class="anchor" aria-hidden="true" id="reading-fields"></a><a href="#reading-fields" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>You can get a field from an event by providing the corresponding selector:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event, SpOutputCollector out)</span> </span>{
+
+ PrimitiveField temperatureField = event.getFieldBySelector(PROPERTY_SELECTOR).getAsPrimitive();
+ }
+
+</code></pre>
+<p>Similarly, if your mapping property links to a nested property, use</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event, SpOutputCollector out)</span> </span>{
+
+ NestedField nestedField = event.getFieldBySelector(PROPERTY_SELECTOR).getAsNested();
+ }
+
+</code></pre>
+<p>and for a list-based field:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event, SpOutputCollector out)</span> </span>{
+
+ ListField listField = event.getFieldBySelector(PROPERTY_SELECTOR).getAsList();
+ }
+
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="parsing-fields"></a><a href="#parsing-fields" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<h4><a class="anchor" aria-hidden="true" id="primitive-fields"></a><a href="#primitive-fields" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
+<p>A <code>PrimitiveField</code> contains convenience methods to directly cast a field to the target datatype:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-comment">// parse the value as a float datatype</span>
+Float temperatureValue = event.getFieldBySelector(temperatureSelector).getAsPrimitive().getAsFloat();
+
+<span class="hljs-comment">// or do the same with a double datatype</span>
+Double temperatureValue = event.getFieldBySelector(temperatureSelector).getAsPrimitive().getAsDouble();
+
+<span class="hljs-comment">// extracting a string</span>
+String deviceId = event.getFieldBySelector(deviceIdSelector).getAsPrimitive().getAsString();
+
+<span class="hljs-comment">// this also works for extracting fields from nested fields:</span>
+Double latitude = event.getFieldBySelector(latitudeSelector).getAsPrimitive().getAsDouble();
+
+<span class="hljs-comment">// extracting boolean values</span>
+Boolean running = event.getFieldBySelector(runningSelector).getAsPrimitive().getAsBoolean();
+</code></pre>
+<p>In rare cases, you might want to receive a field directly based on the runtime name as follows:</p>
+<pre><code class="hljs css language-java">Double temperature = event.getFieldByRuntimeName(<span class="hljs-string">"temperature"</span>).getAsPrimitive().getAsDouble();
+</code></pre>
+<h4><a class="anchor" aria-hidden="true" id="list-fields"></a><a href="#list-fields" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Lists can also be retrieved by providing the corresponding selector and can automatically be parsed to a list of primitive datatypes:</p>
+<pre><code class="hljs css language-java">
+List<Integer> lastValues = event.getFieldBySelector(lastValueSelector).getAsList().parseAsSimpleType(Integer<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+
+</code></pre>
+<p>(coming soon: parsing complex lists)</p>
+<h3><a class="anchor" aria-hidden="true" id="addingupdating-fields"></a><a href="#addingupdating-fields" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2 [...]
+<p>Primitive fields can easily be added to an event by providing the runtime name and the object:</p>
+<pre><code class="hljs css language-java">
+ <span class="hljs-comment">// add a primitive field with runtime name "city" and value "Karlsruhe"</span>
+ event.addField(<span class="hljs-string">"city"</span>, <span class="hljs-string">"Karlsruhe"</span>);
+
+ <span class="hljs-comment">// remove the field "temperature" from the event</span>
+ event.removeFieldBySelector(temperatureSelector);
+
+ <span class="hljs-comment">// add a new field</span>
+ event.addField(<span class="hljs-string">"fahrenheit"</span>, <span class="hljs-number">48</span>);
+</code></pre>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/extend-tutorial-data-sinks.html"><span class="arrow-prev">← </span><span>Tutorial: Data Sinks</span></a><a class="docs-next button" href="/docs/docs/0.70.0/extend-sdk-stream-requirements.html"><span>SDK: Stream Requirements</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#introduction">Introduction</a></li>< [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/extend-sdk-migration-service-discovery.html b/docs/docs/0.70.0/extend-sdk-migration-service-discovery.html
new file mode 100644
index 00000000..9f6911eb
--- /dev/null
+++ b/docs/docs/0.70.0/extend-sdk-migration-service-discovery.html
@@ -0,0 +1,164 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Migration Guide: New Service Discovery in 0.69.0 · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Introduction"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" conte [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Migration Guide: New Service Discovery in 0.69.0</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="introduction"></a><a href="#introduction" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" w [...]
+<p>As part of our roadmap towards a release 1.0, Apache StreamPipes 0.69.0 features a new service discovery approach along with performance improvements related to a new storage layer for pipeline element descriptions.</p>
+<p>The new service discovery approach is better suited for cloud-native scenarios, as the hostname of a pipeline element is now decoupled from its description. As such, StreamPipes now supports recovery of pipeline elements independent from their assigned host.
+In addition, the new approach simplifies development of StreamPipes, e.g., in cases where the core is running in Docker and pipeline elements are developed on a local machine. In this case, the IP of the host machine should now be auto-discovered so that provision of environement variables should now be obsolete in most cases.
+The second large improvement is related to the replacement of RDF4J as the storage engine with a NoSQL database. This leads to much faster load times (you will notice this especially at system startup).</p>
+<p>While we are heavily working towards a stable release 1.0, we decided to put our efforts into the remaining features required for 1.0 and do not provide an auto-migration related to some breaking changes.
+Therefore, we recommend to reinstall StreamPipes when updating to 0.69.0. We currently plan to have at most two more releases before releasing the first 1.x version of StreamPipes.</p>
+<h2><a class="anchor" aria-hidden="true" id="installation"></a><a href="#installation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83. [...]
+<ul>
+<li>Before upgrading to 0.69.0, clean any existing installation (e.g., by running <code>docker-compose down -v</code>) and make sure that no volumes of StreamPipes are left.</li>
+<li>Upgrade to the latest installer version (currently the dev branch of incubator-streampipes-installer)</li>
+<li>Upon restart, make sure that the setup dialog appears (make sure that the new StreamPipes logo appears) and re-initialize the system.</li>
+</ul>
+<h2><a class="anchor" aria-hidden="true" id="sdk-changes"></a><a href="#sdk-changes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>0.69.0 comes with a new <code>ServiceDefinitionBuilder</code> for pipelines, which simplifies the definition of a pipeline element.</p>
+<p>The ServiceDefinitionBuilder requires an ID of your extensions service, an optional title and description and a default port.
+It is best to provide 8090 as the default port, so that this will be the standard port of all StreamPipes extensions services at deployment time in a containerized environment.
+The port port can always be overriden by providing an <code>SP_PORT</code> environment variable.</p>
+<h3><a class="anchor" aria-hidden="true" id="init-class"></a><a href="#init-class" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1 [...]
+<p>Modify the Init class of your pipeline element service as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">ExamplesInit</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">StandaloneModelSubmitter</span> </span>{
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">main</span><span class="hljs-params">(String[] args)</span> </span>{
+ <span class="hljs-keyword">new</span> ExamplesInit().init();
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> SpServiceDefinition <span class="hljs-title">provideServiceDefinition</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> SpServiceDefinitionBuilder.create(<span class="hljs-string">"org.apache.streampipes.processors.examples.jvm"</span>,
+ <span class="hljs-string">"StreamPipes Code Examples"</span>,
+ <span class="hljs-string">""</span>,
+ <span class="hljs-number">8090</span>)
+ .registerMessagingProtocols(<span class="hljs-keyword">new</span> SpKafkaProtocolFactory(), <span class="hljs-keyword">new</span> SpJmsProtocolFactory())
+ .registerMessagingFormats(<span class="hljs-keyword">new</span> JsonDataFormatFactory())
+ .registerPipelineElement(<span class="hljs-keyword">new</span> MyPipelineElementController())
+ .registerAdapter(<span class="hljs-keyword">new</span> MyAdapter())
+ .build();
+ }
+}
+</code></pre>
+<p>You can now easily define a StreamPipes extensions service that supports both custom adapters and pipeline elements by using the following Maven dependency:
+This is optional and no changes to your existing Maven dependencies (except the version, e.g., 0.69.0-SNAPSHOT) are required.</p>
+<pre><code class="hljs css language-maven"><span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>org.apache.streampipes<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
+ <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>streampipes-container-extensions<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
+<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="configs"></a><a href="#configs" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1- [...]
+<p>Prior to version 0.69.0, additionally configs had to be provided in a separate <code>Config</code> class. This is now obsolete - configs can be directly provided within the builder class as follows:</p>
+<pre><code class="hljs css language-java">
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> SpServiceDefinition <span class="hljs-title">provideServiceDefinition</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> SpServiceDefinitionBuilder.create(<span class="hljs-string">"org.apache.streampipes.processors.examples.jvm"</span>,
+ <span class="hljs-string">"StreamPipes Code Examples"</span>,
+ <span class="hljs-string">""</span>,
+ <span class="hljs-number">8090</span>)
+ .registerPipelineElement(<span class="hljs-keyword">new</span> MyPipelineElement())
+ .registerAdapter(<span class="hljs-keyword">new</span> MyAdapter())
+ .addConfig(<span class="hljs-string">"key"</span>, <span class="hljs-number">1</span>)
+ .addConfig(<span class="hljs-string">"my-string-config"</span>, <span class="hljs-string">"myvalue"</span>)
+ .build();
+ }
+</code></pre>
+<p>Configs can be easily accessed from the <code>EventProcessorRuntimeContext</code> (or <code>EventSinkRuntimeContext</code>):</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onInvocation</span><span class="hljs-params">(Parameters params,
+ SpOutputCollector spOutputCollector,
+ EventProcessorRuntimeContext context)</span> </span>{
+
+ Integer myConfigValue = context.getConfigStore().getConfig().getInteger(<span class="hljs-string">"key"</span>);
+ }
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="service-discovery"></a><a href="#service-discovery" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2- [...]
+<p>An extensions service can be started by executing the Init class. StreamPipes will now automatically select the proper service IP address and register the service in Consul.
+You can inspect the selected IP address in the console:</p>
+<pre><code class="hljs"><span class="hljs-number">16</span>:<span class="hljs-number">41</span>:<span class="hljs-number">58.342</span> SP [main] INFO o.a.s.commons.networking.Networking - Using <span class="hljs-built_in">auto</span>-discovered IP: <span class="hljs-number">172.30</span><span class="hljs-number">.80</span><span class="hljs-number">.1</span>
+<span class="hljs-number">16</span>:<span class="hljs-number">41</span>:<span class="hljs-number">58.364</span> SP [main] INFO o.a.s.commons.networking.Networking - Using port <span class="hljs-keyword">from</span> provided environment variable SP_PORT: <span class="hljs-number">6025</span>
+<span class="hljs-number">16</span>:<span class="hljs-number">41</span>:<span class="hljs-number">58.367</span> SP [main] INFO o.a.s.c.init.DeclarersSingleton - Registering <span class="hljs-number">0</span> configs <span class="hljs-keyword">in</span> key/value store
+<span class="hljs-number">16</span>:<span class="hljs-number">41</span>:<span class="hljs-number">58.400</span> SP [main] INFO o.a.s.s.consul.ConsulProvider - Checking <span class="hljs-keyword">if</span> consul <span class="hljs-keyword">is</span> available...
+<span class="hljs-number">16</span>:<span class="hljs-number">41</span>:<span class="hljs-number">58.419</span> SP [main] INFO o.a.s.s.consul.ConsulProvider - Successfully connected to Consul
+</code></pre>
+<p>In some (rare) cases, a non-resolvable IP will be selected. In this case, you can manually override the IP by providing a <code>SP_HOST</code> environment variable. This falls back to a similar behaviour as in pre-0.69.0-versions and will use the manually provided IP.</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/extend-sdk-output-strategies.html"><span class="arrow-prev">← </span><span>SDK: Output Strategies</span></a><a class="docs-next button" href="/docs/docs/0.70.0/technicals-architecture.html"><span>Architecture</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#introduction">Introduction</a></li><li><a href="#in [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/extend-sdk-output-strategies.html b/docs/docs/0.70.0/extend-sdk-output-strategies.html
new file mode 100644
index 00000000..3cd1df78
--- /dev/null
+++ b/docs/docs/0.70.0/extend-sdk-output-strategies.html
@@ -0,0 +1,342 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SDK Guide: Output Strategies · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Introduction"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="SDK Guide: Outpu [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">SDK Guide: Output Strategies</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="introduction"></a><a href="#introduction" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill [...]
+<p>In StreamPipes, output strategies determine the output of a data processor.
+As the exact input schema of a processor is usually not yet known at development time (as processors can be connected with any stream that matches their requirements), output strategies are a concept to define how an input data stream is transformed to an output data stream.</p>
+<p>The following reference describes how output strategies can be defined using the SDK.</p>
+<div class="admonition tip">
+<div class="admonition-title">Code on Github</div>
+<p>For all examples, the code can be found on <a href="https://www.github.com/apache/incubator-streampipes-examples
+/tree/dev/streampipes-pipeline-elements-examples-processors-jvm/src/main/java/org/apache/streampipes/pe/examples/jvm
+/outputstrategy/">Github</a>.</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="reference"></a><a href="#reference" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>The methods described below to create static properties are available in the <code>ProcessingElementBuilder</code> class and are usually used in the <code>declareModel</code> method of the controller class.</p>
+<p>As follows, we will use the following example event to explain how output strategies define the output of a data processor:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temperature"</span> : <span class="hljs-number">37.0</span>,
+ <span class="hljs-attr">"deviceId"</span> : <span class="hljs-string">"1"</span>
+
+}
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="keep-output"></a><a href="#keep-output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>A <code>KeepOutputStrategy</code> declares that the output event schema will be equal to the input event schema.
+In other terms, the processor does not change the schema, but might change the values of event properties.</p>
+<p>A keep output strategy can be defined as follows:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".keep"</span>, <span class="hljs-string">"Keep output example example"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredProperty(EpRequirements.anyProperty())
+ .build())
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+
+ <span class="hljs-comment">// declaring a keep output strategy</span>
+ .outputStrategy(OutputStrategies.keep())
+
+ .build();
+ }
+
+</code></pre>
+<p>According to the example above, the expected output event schema of the example input event would be:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temperature"</span> : <span class="hljs-number">37.0</span>,
+ <span class="hljs-attr">"deviceId"</span> : <span class="hljs-string">"1"</span>
+
+}
+</code></pre>
+<p>Data processors that perform filter operations (e.g., filtering temperature values that are above a given threshold) are a common example for using keep output strategies.</p>
+<h3><a class="anchor" aria-hidden="true" id="fixed-output"></a><a href="#fixed-output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83. [...]
+<p>A <code>FixedOutputStrategy</code> declares that the data processor itself provides the event schema. The output schema does not depend on the input event.</p>
+<p>Fixed output strategies need to provide the event schema they produce at development time:</p>
+<pre><code class="hljs css language-java">
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".fixed"</span>, <span class="hljs-string">"Fixed output example"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredProperty(EpRequirements.anyProperty())
+ .build())
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+
+ <span class="hljs-comment">// the fixed output strategy provides the schema</span>
+ .outputStrategy(OutputStrategies.fixed(EpProperties.timestampProperty(<span class="hljs-string">"timestamp"</span>),
+ EpProperties.doubleEp(Labels.from(<span class="hljs-string">"avg"</span>, <span class="hljs-string">"Average value"</span>, <span class="hljs-string">""</span>), <span class="hljs-string">"avg"</span>, SO.Number)))
+
+ .build();
+ }
+
+</code></pre>
+<p>In this example, we declare that the output schema always consists of two fields (<code>timestamp</code> and <code>avg</code>).</p>
+<p>Therefore, an output event should look like:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"avg"</span> : <span class="hljs-number">36.0</span>
+}
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="append-output"></a><a href="#append-output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>An <code>AppendOutputStrategy</code> appends additional fields to a schema of an incoming event stream. For instance, data processors that perform enrichment operations usually make use of append output strategies.</p>
+<p>Similar to the fixed output strategy, the additional fields must be provided at development time in the controller method as follows:</p>
+<pre><code class="hljs css language-java"> <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".append"</span>, <span class="hljs-string">"Append output example"</span>, <span class="hljs-string">""</span>)
+
+ <span class="hljs-comment">// boilerplate code not relevant here, see above</span>
+
+ <span class="hljs-comment">// declaring an append output</span>
+ .outputStrategy(OutputStrategies.append(EpProperties.integerEp(Labels.from(<span class="hljs-string">"avg"</span>,
+ <span class="hljs-string">"The average value"</span>, <span class="hljs-string">""</span>), <span class="hljs-string">"avg"</span>, SO.Number)))
+
+ .build();
+ }
+</code></pre>
+<p>In this case, the output event would have an additional field <code>avg</code>:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temperature"</span> : <span class="hljs-number">37.0</span>,
+ <span class="hljs-attr">"deviceId"</span> : <span class="hljs-string">"1"</span>,
+ <span class="hljs-attr">"avg"</span> : <span class="hljs-number">123.0</span>
+
+}
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="custom-output"></a><a href="#custom-output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>In some cases, pipeline developers using the StreamPipes UI should be able to manually select fields from an input event schema. For such use cases, a <code>CustomOutputStrategy</code> can be used:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".custom"</span>, <span class="hljs-string">"Custom output example"</span>, <span class="hljs-string">""</span>)
+
+ <span class="hljs-comment">// boilerplate code not relevant here, see above</span>
+
+ <span class="hljs-comment">// declaring a custom output</span>
+ .outputStrategy(OutputStrategies.custom())
+
+ .build();
+ }
+
+</code></pre>
+<p>If a data processor defines a custom output strategy, the customization dialog in the pipeline editor will show a dialog to let users select the fields to keep:</p>
+<p><img src="/docs/img/dev-guide-output-strategies/os-custom.png" width="80%" alt="Number Parameter"></p>
+<p>Taking our example, and assuming that the user selects both the <code>timestamp</code> and the <code>temperature</code> the expected output event should look like this:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temperature"</span> : <span class="hljs-number">37.0</span>
+}
+</code></pre>
+<p>How do we know which fields were selected once the data processor is invoked? Use the proper method from the extractor in the <code>onInvocation</code> method:</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> ConfiguredEventProcessor<DummyParameters> <span class="hljs-title">onInvocation</span><span class="hljs-params">(DataProcessorInvocation graph, ProcessingElementParameterExtractor extractor)</span> </span>{
+
+ List<String> outputSelectors = extractor.outputKeySelectors();
+
+ <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> ConfiguredEventProcessor<>(<span class="hljs-keyword">new</span> DummyParameters(graph), DummyEngine::<span class="hljs-keyword">new</span>);
+ }
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="transform-output"></a><a href="#transform-output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
+<p>A <code>TransformOutputStrategy</code> declares that one or more fields of an incoming event stream are transformed. Transformations can be applied to the datatype of the property, the runtime name of the property, or any other scheam-related declaration such as measurement units.</p>
+<h4><a class="anchor" aria-hidden="true" id="static-transform-operations"></a><a href="#static-transform-operations" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 1 [...]
+<p>Static transform operations do not depend on any user input (at pipeline development time) in order to know how to transform a field of an incoming event schema.</p>
+<p>Let's say our data processor transforms strings (that are actually a number) to a number datatype. In this case, we can use a static transform output strategy:</p>
+<pre><code class="hljs css language-java">
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".transform"</span>, <span class="hljs-string">"Transform output example example"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.stringReq(), Labels.from
+ (<span class="hljs-string">"str"</span>, <span class="hljs-string">"The date property as a string"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .build())
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+
+ <span class="hljs-comment">// static transform operation</span>
+ .outputStrategy(OutputStrategies.transform(TransformOperations
+ .staticDatatypeTransformation(<span class="hljs-string">"str"</span>, Datatypes.Long)))
+
+ .build();
+ }
+
+</code></pre>
+<p>Note the mapping property that we use to determine which field of the input event should be transformed.</p>
+<p>The expected output event would look like this:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temperature"</span> : <span class="hljs-number">37.0</span>,
+ <span class="hljs-attr">"deviceId"</span> : <span class="hljs-number">1</span>
+}
+</code></pre>
+<h4><a class="anchor" aria-hidden="true" id="dynamic-transform-operations"></a><a href="#dynamic-transform-operations" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 [...]
+<p>Sometimes, user input depends on the exact transform output. Let's take a field renaming processor as an example, which lets the user rename a field from an input event schema to another field name.
+For such use cases, we can use a <code>DynamicTransformOperation</code>:</p>
+<pre><code class="hljs css language-java">
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".transform"</span>, <span class="hljs-string">"Transform output example example"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.stringReq(), Labels.from
+ (<span class="hljs-string">"str"</span>, <span class="hljs-string">"The date property as a string"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .build())
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+
+ <span class="hljs-comment">// the text input to enter the new runtime name</span>
+ .requiredTextparameter(Labels.from(<span class="hljs-string">"new-runtime-name"</span>, <span class="hljs-string">"New Runtime Name"</span>, <span class="hljs-string">""</span>))
+
+ <span class="hljs-comment">// static transform operation</span>
+ .outputStrategy(OutputStrategies.transform(TransformOperations
+ .dynamicRuntimeNameTransformation(<span class="hljs-string">"str"</span>, <span class="hljs-string">"new-runtime-name"</span>)))
+
+ .build();
+ }
+
+</code></pre>
+<p>For dynamic transform operations, an additional identifier that links to another static property can be assigned and later be fetched in the <code>onInvocation</code> method.</p>
+<p>Assuming we want to rename the field <code>temperature</code> to <code>temp</code>, the resulting output event should look like this:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">1234556</span>,
+ <span class="hljs-attr">"temp"</span> : <span class="hljs-number">37.0</span>,
+ <span class="hljs-attr">"deviceId"</span> : <span class="hljs-number">1</span>
+}
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="custom-transform-output"></a><a href="#custom-transform-output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 [...]
+<p>Finally, in some cases the output schema cannot be described at pipeline development time. For these (usually rare) cases, a <code>CustomTransformOutput</code> strategy can be used.</p>
+<p>In this case, a callback function will be invoked in the controller class just after a user has filled in any static properties and clicks on <code>Save</code> in the pipeline editor.</p>
+<p>To define a custom transform output, we need to implement an interface in the controller class:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">CustomTransformOutputController</span> <span class="hljs-keyword">extends</span>
+ <span class="hljs-title">StandaloneEventProcessingDeclarer</span><<span class="hljs-title">DummyParameters</span>> <span class="hljs-keyword">implements</span>
+ <span class="hljs-title">ResolvesContainerProvidedOutputStrategy</span><<span class="hljs-title">DataProcessorInvocation</span>, <span class="hljs-title">ProcessingElementParameterExtractor</span>> </span>{
+
+
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> EventSchema <span class="hljs-title">resolveOutputStrategy</span><span class="hljs-params">(DataProcessorInvocation processingElement, ProcessingElementParameterExtractor parameterExtractor)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+
+ }
+}
+</code></pre>
+<p>In addition, the output strategy must be declared in the <code>declareModel</code> method:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.outputstrategy"</span> +
+ <span class="hljs-string">".customtransform"</span>, <span class="hljs-string">"Custom transform output example example"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.stringReq(), Labels.from
+ (<span class="hljs-string">"str"</span>, <span class="hljs-string">"The date property as a string"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .build())
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+
+ <span class="hljs-comment">// declare a custom transform output</span>
+ .outputStrategy(OutputStrategies.customTransformation())
+
+ .build();
+ }
+
+</code></pre>
+<p>Once a new pipeline using this data processor is created and the configuration is saved, the <code>resolveOutputStrategy</code> method will be called, so that an event schema can be provided based on the given configuration. An extractor instance (see the guide on static properties) is available to extract the selected static properties and the connected event stream.</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> EventSchema <span class="hljs-title">resolveOutputStrategy</span><span class="hljs-params">(DataProcessorInvocation processingElement, ProcessingElementParameterExtractor parameterExtractor)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+ <span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> EventSchema(Arrays
+ .asList(EpProperties
+ .stringEp(Labels.from(<span class="hljs-string">"runtime"</span>, <span class="hljs-string">"I was added at runtime"</span>, <span class="hljs-string">""</span>), <span class="hljs-string">"runtime"</span>, SO.Text)));
+ }
+</code></pre>
+<p>In this example, the output event schema should look like this:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"runtime"</span> : <span class="hljs-string">"Hello world!"</span>
+}
+</code></pre>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/extend-sdk-static-properties.html"><span class="arrow-prev">← </span><span>SDK: Static Properties</span></a><a class="docs-next button" href="/docs/docs/0.70.0/extend-sdk-migration-service-discovery.html"><span>Migration Guide: 0.69.0</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#introduction">Introductio [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/extend-sdk-static-properties.html b/docs/docs/0.70.0/extend-sdk-static-properties.html
new file mode 100644
index 00000000..bd5ec2f0
--- /dev/null
+++ b/docs/docs/0.70.0/extend-sdk-static-properties.html
@@ -0,0 +1,239 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SDK Guide: Static Properties · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Introduction"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="SDK Guide: Stati [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">SDK Guide: Static Properties</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="introduction"></a><a href="#introduction" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill [...]
+<p>Static properties represent user-faced parameters that are provided by pipeline developers.
+Processing elements can specify required static properties, which will render different UI views in the pipeline editor.</p>
+<p>The following reference describes how static properties can be defined using the SDK.</p>
+<div class="admonition tip">
+<div class="admonition-title">Code on Github</div>
+<p>For all examples, the code can be found on <a href="https://github.com/apache/incubator-streampipes-examples/tree
+/dev/streampipes-pipeline-elements-examples-processors-jvm/src/main/java/org/apache/streampipes/pe/examples/jvm
+/staticproperty">Github</a>.</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="reference"></a><a href="#reference" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>The methods described below to create static properties are available in the <code>ProcessingElementBuilder</code> and <code>DataSinkBuilder</code> classes and are usually used in the <code>declareModel</code> method of the controller class.</p>
+<h3><a class="anchor" aria-hidden="true" id="mapping-property"></a><a href="#mapping-property" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
+<p>In StreamPipes, processing elements usually operate on fields of an event stream. For instance, a filter processor operates on a specific field from an input stream (e.g., a field measuring the temperature).
+Typically, pipeline developers should select the exact field where the operations is applied upon by themselves.
+As this field is not yet known at pipeline element development time (as it is defined by the pipeline developer in the pipeline editor), mapping properties serve to map a stream requirement to a specific field from the actual input event stream.</p>
+<h3><a class="anchor" aria-hidden="true" id="unary-mapping-property"></a><a href="#unary-mapping-property" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0 [...]
+<p>A unary mapping property maps a stream requirement to an actual field of an event stream. Therefore, the <code>StreamRequirementsBuilder</code> provides the opportunity to directly add a mapping property based along with a property requirement:</p>
+<pre><code class="hljs css language-java">.requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.numberReq(),
+ Labels.from(<span class="hljs-string">"mp-key"</span>, <span class="hljs-string">"My Mapping"</span>, <span class="hljs-string">""</span>),
+ PropertyScope.NONE)
+ .build())
+</code></pre>
+<p>This leads to a selection dialog in the pipeline element customization which provides the user with a selection of all event properties (fields) from the input stream that match the specified property requirement:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-mapping-unary.png" width="80%" alt="Text"></p>
+<p>At invocation time, the value can be extracted in the <code>onInvocation</code> method as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// Extract the mapping property value</span>
+String mappingPropertySelector = extractor.mappingPropertyValue(<span class="hljs-string">"mp-key"</span>);
+</code></pre>
+<p>Note that this method returns a <code>PropertySelector</code>, which can be used by the event model to extract the actual value of this field.</p>
+<h3><a class="anchor" aria-hidden="true" id="n-ary-mapping-property"></a><a href="#n-ary-mapping-property" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0 [...]
+<p>N-ary mapping properties work similar to unary mapping properties, but allow the mapping of one requirement to multiple event properties matching the requirement:</p>
+<pre><code class="hljs css language-java">.requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredPropertyWithNaryMapping(EpRequirements.numberReq(),
+ Labels.from(<span class="hljs-string">"mp-key"</span>, <span class="hljs-string">"My Mapping"</span>, <span class="hljs-string">""</span>),
+ PropertyScope.NONE)
+ .build())
+</code></pre>
+<p>This renders the following selection, where users can select more than one matching event property:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-mapping-nary.png" width="80%" alt="Text"></p>
+<p>The following snippet returns a list containing the property selectors of all event properties that have been selected:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// Extract the mapping property value</span>
+List<String> mappingPropertySelectors = extractor.mappingPropertyValues(<span class="hljs-string">"mp-key"</span>);
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="free-text-parameters"></a><a href="#free-text-parameters" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1 [...]
+<p>A free-text parameter requires the pipeline developer to enter a single value - which can be a string or another primitive data type.
+The input of free-text parameters can be restricted to specific value ranges or can be linked to the value set of a connected input data stream.</p>
+<h4><a class="anchor" aria-hidden="true" id="text-parameters"></a><a href="#text-parameters" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 [...]
+<p>A text parameter lets the user enter a string value. The following code line in the controller class</p>
+<pre><code class="hljs css language-java">.requiredTextParameter(Labels.from(SP_KEY, <span class="hljs-string">"Example Name"</span>, <span class="hljs-string">"Example Description"</span>))
+</code></pre>
+<p>leads to the following input dialog in the pipeline editor:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-text-parameter.png" width="80%" alt="Text"></p>
+<p>Users can enter any value that will be converted to a string datatype. To receive the entered value in the <code>onInvocation</code> method, use the following method from the <code>ParameterExtractor</code></p>
+<pre><code class="hljs css language-java">String textParameter = extractor.singleValueParameter(SP_KEY, String<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+</code></pre>
+<h4><a class="anchor" aria-hidden="true" id="number-parameters"></a><a href="#number-parameters" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2- [...]
+<p>A number parameter lets the user enter a number value, either a floating-point number or an integer:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// create an integer parameter</span>
+.requiredIntegerParameter(Labels.from(SP_KEY, <span class="hljs-string">"Integer Parameter"</span>, <span class="hljs-string">"Example Description"</span>))
+
+<span class="hljs-comment">// create a float parameter</span>
+.requiredFloatParameter(Labels.from(<span class="hljs-string">"float-key"</span>, <span class="hljs-string">"Float Parameter"</span>, <span class="hljs-string">"Example Description"</span>))
+
+</code></pre>
+<p>leads to the following input dialog in the pipeline editor only accepting integer values:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-number-parameter.png" width="80%" alt="Number Parameter"></p>
+<p>The pipeline editor performs type validation and ensures that only numbers can be added by the user. To receive the entered value in the <code>onInvocation</code> method, use the following method from the <code>ParameterExtractor</code></p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// Extract the integer parameter value</span>
+Integer integerParameter = extractor.singleValueParameter(SP_KEY, Integer<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+
+<span class="hljs-comment">// Extract the float parameter value</span>
+Float floatParameter = extractor.singleValueParameter(<span class="hljs-string">"float-key"</span>, Float<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+
+</code></pre>
+<h4><a class="anchor" aria-hidden="true" id="numbers-with-value-specification"></a><a href="#numbers-with-value-specification" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13. [...]
+<p>You can also specify the value range of a number-based free text parameter:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// create an integer parameter with value range</span>
+.requiredIntegerParameter(Labels.from(SP_KEY, <span class="hljs-string">"Integer Parameter"</span>, <span class="hljs-string">"Example Description"</span>), <span class="hljs-number">0</span>, <span class="hljs-number">100</span>, <span class="hljs-number">1</span>)
+
+</code></pre>
+<p>which renders the following input field:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-number-parameter-with-range.png" width="80%" alt="Number Parameter"></p>
+<p>Receive the entered value in the same way as a standard number parameter.</p>
+<h4><a class="anchor" aria-hidden="true" id="free-text-parameters-linked-to-an-event-property"></a><a href="#free-text-parameters-linked-to-an-event-property" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9z [...]
+<h3><a class="anchor" aria-hidden="true" id="single-value-selections"></a><a href="#single-value-selections" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 [...]
+<p>Single-value selections let the user select from a pre-defined list of options.
+A single-value selection requires to select exactly one option.</p>
+<pre><code class="hljs css language-java">.requiredSingleValueSelection(Labels.from(<span class="hljs-string">"id"</span>, <span class="hljs-string">"Example Name"</span>, <span class="hljs-string">"Example Description"</span>),
+ Options.from(<span class="hljs-string">"Option A"</span>, <span class="hljs-string">"Option B"</span>, <span class="hljs-string">"Option C"</span>))
+
+</code></pre>
+<p>Single-value selections will be rendered as a set of radio buttons in the pipeline editor:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-single-selection.png" width="80%" alt="Number Parameter"></p>
+<p>To extract the selected value, use the following method from the parameter extractor:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// Extract the selected value</span>
+String selectedSingleValue = extractor.selectedSingleValue(<span class="hljs-string">"id"</span>, String<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+</code></pre>
+<div class="admonition tip">
+<div class="admonition-title">Declaring options</div>
+<p>Sometimes, you may want to use an internal name that differs from the display name of an option.
+For that, you can use the method Options.from(Tuple2<String, String>) and the extractor method selectedSingleValueInternalName.</p>
+</div>
+<h3><a class="anchor" aria-hidden="true" id="multi-value-selections"></a><a href="#multi-value-selections" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0 [...]
+<p>Multi-value selections let the user select from a pre-defined list of options, where multiple or no option might be selected.</p>
+<pre><code class="hljs css language-java">.requiredMultiValueSelection(Labels.from(<span class="hljs-string">"id"</span>, <span class="hljs-string">"Example Name"</span>, <span class="hljs-string">"Example Description"</span>),
+ Options.from(<span class="hljs-string">"Option A"</span>, <span class="hljs-string">"Option B"</span>, <span class="hljs-string">"Option C"</span>))
+
+</code></pre>
+<p>Multi-value selections will be rendered as a set of checkboxes in the pipeline editor:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-multi-selection.png" width="80%" alt="Number Parameter"></p>
+<p>To extract the selected value, use the following method from the parameter extractor:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// Extract the selected value</span>
+List<String> selectedMultiValue = extractor.selectedMultiValues(<span class="hljs-string">"id"</span>, String<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="domain-concepts"></a><a href="#domain-concepts" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 [...]
+<p>(coming soon...)</p>
+<h3><a class="anchor" aria-hidden="true" id="collections"></a><a href="#collections" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>You can also define collections based on other static properties.</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// create a collection parameter</span>
+.requiredParameterAsCollection(Labels.from(<span class="hljs-string">"collection"</span>, <span class="hljs-string">"Example Name"</span>, <span class="hljs-string">"Example "</span> +
+ <span class="hljs-string">"Description"</span>), StaticProperties.stringFreeTextProperty(Labels
+ .from(<span class="hljs-string">"text-property"</span>,<span class="hljs-string">"Text"</span>,<span class="hljs-string">""</span>)))
+</code></pre>
+<p>While the items of the collection can be provided in the same way as the underlying static property, the UI provides buttons to add and remove items to the collections.</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-collection.png" width="80%" alt="Number Parameter"></p>
+<p>To extract the selected values from the collection, use the following method from the parameter extractor:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// Extract the text parameter value</span>
+List<String> textParameters = extractor.singleValueParameterFromCollection(<span class="hljs-string">"collection"</span>, String<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="runtime-resolvable-selections"></a><a href="#runtime-resolvable-selections" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 [...]
+<p>In some cases, the options of selection parameters are not static, but depend on other values or might change at runtime. In this case, you can use runtime-resolvable selections.</p>
+<p>First, let your controller class implement <code>ResolvesContainerProvidedOptions</code>:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">RuntimeResolvableSingleValue</span> <span class="hljs-keyword">extends</span>
+ <span class="hljs-title">StandaloneEventProcessingDeclarer</span><<span class="hljs-title">DummyParameters</span>> <span class="hljs-keyword">implements</span> <span class="hljs-title">ResolvesContainerProvidedOptions</span> </span>{ ... }
+</code></pre>
+<p>Next, define the parameter in the <code>declareModel</code> method:</p>
+<pre><code class="hljs css language-java"><span class="hljs-comment">// create a single value selection parameter that is resolved at runtime</span>
+ .requiredSingleValueSelectionFromContainer(Labels.from(<span class="hljs-string">"id"</span>, <span class="hljs-string">"Example Name"</span>, <span class="hljs-string">"Example "</span> +
+ <span class="hljs-string">"Description"</span>))
+</code></pre>
+<p>Finally, implement the method <code>resolveOptions</code>, which will be called at runtime once the processor is used:</p>
+<pre><code class="hljs css language-java"> <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> List<RuntimeOptions> <span class="hljs-title">resolveOptions</span><span class="hljs-params">(String requestId, EventProperty linkedEventProperty)</span> </span>{
+ <span class="hljs-keyword">return</span> Arrays.asList(<span class="hljs-keyword">new</span> RuntimeOptions(<span class="hljs-string">"I was defined at runtime"</span>, <span class="hljs-string">""</span>));
+ }
+</code></pre>
+<p>The UI will render a single-value parameter based on the options provided at runtime:</p>
+<p><img src="/docs/img/dev-guide-static-properties/sp-single-selection-remote.png" width="80%" alt="Number Parameter"></p>
+<p>The parameter extraction does not differ from the extraction of static single-value parameters.</p>
+<div class="admonition info">
+<div class="admonition-title">Multi-value selections</div>
+<p>Although this example shows the usage of runtime-resolvable selections using single value selections, the same also works for multi-value selections!</p>
+</div>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/extend-sdk-stream-requirements.html"><span class="arrow-prev">← </span><span>SDK: Stream Requirements</span></a><a class="docs-next button" href="/docs/docs/0.70.0/extend-sdk-output-strategies.html"><span>SDK: Output Strategies</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#introduction">Introduction</a></ [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/extend-sdk-stream-requirements.html b/docs/docs/0.70.0/extend-sdk-stream-requirements.html
new file mode 100644
index 00000000..22189009
--- /dev/null
+++ b/docs/docs/0.70.0/extend-sdk-stream-requirements.html
@@ -0,0 +1,214 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>SDK Guide: Stream Requirements · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="## Introduction"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="SDK Guide: Str [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">SDK Guide: Stream Requirements</h1></header><article><div><span><h2><a class="anchor" aria-hidden="true" id="introduction"></a><a href="#introduction" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fi [...]
+<p>Data processors and data sinks can define <code>StreamRequirements</code>. Stream requirements allow pipeline elements to express requirements on an incoming event stream that are needed for the element to work properly.
+Once users create pipelines in the StreamPipes Pipeline Editor, these requirements are verified against the connected event stream.
+By using this feature, StreamPipes ensures that only pipeline elements can be connected that are syntactically and semantically valid.</p>
+<p>This guide covers the creation of stream requirements. Before reading this section, we recommend that you make yourself familiar with the SDK guide on <a href="/docs/docs/0.70.0/dev-guide-sdk-guide-processors.html">data processors</a> and <a href="/docs/docs/0.70.0/dev-guide-sdk-guide-sinks.html">data sinks</a>.</p>
+<div class="admonition tip">
+<div class="admonition-title">Code on Github</div>
+<p>For all examples, the code can be found on <a href="https://www.github.com/apache/incubator-streampipes-examples/tree/dev/streampipes-pipeline-elements-examples-processors-jvm/src/main/java/org/apache/streampipes/pe/examples/jvm/requirements/">Github</a>.</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="the-streamrequirementsbuilder"></a><a href="#the-streamrequirementsbuilder" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 [...]
+<p>Stream requirements can be defined in the <code>declareModel</code> method of the pipeline element class. Start with a method body like this:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(ID, PIPELINE_ELEMENT_NAME, DESCRIPTION)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+
+ .build())
+
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+ .outputStrategy(OutputStrategies.keep())
+
+ .build();
+ }
+</code></pre>
+<p>The <code>StreamRequirementsBuilder</code> class provides methods to add stream requirements to a pipeline element.</p>
+<h2><a class="anchor" aria-hidden="true" id="requirements-on-primitive-fields"></a><a href="#requirements-on-primitive-fields" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13. [...]
+<p>As a very first example, let's assume we would like to create a data processor that filters numerical values that are above a given threshold.
+Consequently, any data stream that is connected to the filter processor needs to provide a numerical value.</p>
+<p>The stream requirement would be assigned as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(ID, PIPELINE_ELEMENT_NAME, DESCRIPTION)
+ .requiredStream(StreamRequirementsBuilder
+ .create()
+ .requiredProperty(EpRequirements.numberReq())
+ .build())
+
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+ .outputStrategy(OutputStrategies.keep())
+
+ .build();
+ }
+</code></pre>
+<p>Note the line starting with <code>requiredProperty</code>, which requires any stream to provide a datatype of type <code>number</code>.</p>
+<p>In many cases, you'll want to let the user select a specific field from a data stream from all available fields that match the specified requirement. For that, you simply use the method <code>requiredPropertyWithUnaryMapping</code> as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(ID, PIPELINE_ELEMENT_NAME, DESCRIPTION)
+ .requiredStream(StreamRequirementsBuilder
+ .create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.numberReq(),
+ Labels.from(<span class="hljs-string">"number-mapping"</span>, <span class="hljs-string">"The value that should be filtered"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .build())
+
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+ .outputStrategy(OutputStrategies.keep())
+
+ .build();
+ }
+</code></pre>
+<p>See also the developer guide on <a href="/docs/docs/0.70.0/dev-guide-static-properties.html">static properties</a> to better understand the usage of <code>MappingProperties</code>.</p>
+<p>Requirements on primitive fields can be specified for all common datatypes:</p>
+<pre><code class="hljs css language-java"> <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.requirements"</span> +
+ <span class="hljs-string">".simple"</span>, <span class="hljs-string">"Simple requirements specification examples"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredProperty(EpRequirements.numberReq()) <span class="hljs-comment">// any number</span>
+ .requiredProperty(EpRequirements.doubleReq()) <span class="hljs-comment">// any field of type double</span>
+ .requiredProperty(EpRequirements.booleanReq()) <span class="hljs-comment">// any field of type boolean</span>
+ .requiredProperty(EpRequirements.integerReq()) <span class="hljs-comment">// any field of type integer</span>
+ .requiredProperty(EpRequirements.stringReq()) <span class="hljs-comment">// any field of type string</span>
+
+ .requiredProperty(EpRequirements.anyProperty()) <span class="hljs-comment">// any field allowed (no restriction)</span>
+ .requiredProperty(EpRequirements.timestampReq()) <span class="hljs-comment">// any timestamp field</span>
+ .build())
+
+
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+ .outputStrategy(OutputStrategies.keep())
+
+ .build();
+</code></pre>
+<h3><a class="anchor" aria-hidden="true" id="specifying-semantics"></a><a href="#specifying-semantics" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1 [...]
+<p>For some algorithms, only specifying the datatype is not sufficient. Let's consider a geofencing algorithm that detects the precense some geospatial coordinate (e.g., from a vehicle) within a given location.</p>
+<p>You could specify something like this:</p>
+<pre><code class="hljs css language-java"> StreamRequirementsBuilder
+ .create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.doubleEp(), Labels.from(<span class="hljs-string">"mapping-latitude"</span>, <span class="hljs-string">"Latitude"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .requiredPropertyWithUnaryMapping(EpRequirements.doubleEp(), Labels.from(<span class="hljs-string">"mapping-longitude"</span>, <span class="hljs-string">"Longitude"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .build()
+</code></pre>
+<p>However, this would allow users to create strange pipelines as users could connect any stream containing a double value to our geofencing algorithm.
+To avoid such situations, you can also specify requirements based on the semantics of a field:</p>
+<pre><code class="hljs css language-java"> StreamRequirementsBuilder
+ .create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.domainPropertyReq(SO.Latitude), Labels.from(<span class="hljs-string">"mapping-latitude"</span>, <span class="hljs-string">"Latitude"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .requiredPropertyWithUnaryMapping(EpRequirements.domainPropertyReq(SO.Longitude), Labels.from(<span class="hljs-string">"mapping-longitude"</span>, <span class="hljs-string">"Longitude"</span>, <span class="hljs-string">""</span>), PropertyScope.NONE)
+ .build()
+</code></pre>
+<p>Note that in this case, we make use of Schema.org's <code>Latitude</code> concept (<a href="https://schema.org/latitude">https://schema.org/latitude</a>). StreamPipes already includes popular vocabularies for specifying semantics. You are also free to use your own vocabularies.</p>
+<h2><a class="anchor" aria-hidden="true" id="requirements-on-lists"></a><a href="#requirements-on-lists" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2 [...]
+<p>Similarly to primitive requirements, you can define processors that require data streams with list fields, see the following examples:</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.examples.requirements"</span> +
+ <span class="hljs-string">".list"</span>, <span class="hljs-string">"List requirements specification examples"</span>, <span class="hljs-string">""</span>)
+ .requiredStream(StreamRequirementsBuilder.
+ create()
+ .requiredProperty(EpRequirements.listRequirement(Datatypes.Integer))
+ .requiredProperty(EpRequirements.listRequirement(Datatypes.Double))
+ .requiredProperty(EpRequirements.listRequirement(Datatypes.Boolean))
+ .requiredProperty(EpRequirements.listRequirement(Datatypes.String))
+ .build())
+
+
+ .supportedProtocols(SupportedProtocols.kafka())
+ .supportedFormats(SupportedFormats.jsonFormat())
+ .outputStrategy(OutputStrategies.keep())
+
+ .build();
+ }
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="requirements-on-nested-properties"></a><a href="#requirements-on-nested-properties" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S1 [...]
+<p>(coming soon, see the Javadoc for now)</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/extend-sdk-event-model.html"><span class="arrow-prev">← </span><span>SDK: Event Model</span></a><a class="docs-next button" href="/docs/docs/0.70.0/extend-sdk-static-properties.html"><span>SDK: Static Properties</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#introduction">Introduction</a></li><li><a href=" [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/extend-setup.html b/docs/docs/0.70.0/extend-setup.html
new file mode 100644
index 00000000..ecb563e4
--- /dev/null
+++ b/docs/docs/0.70.0/extend-setup.html
@@ -0,0 +1,111 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Development Setup · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Pipeline elements in StreamPipes are provided as standalone microservices. New pipeline elements can be easily developed using the provided Maven archetypes and can be install [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Development Setup</h1></header><article><div><span><p>Pipeline elements in StreamPipes are provided as standalone microservices. New pipeline elements can be easily developed using the provided Maven archetypes and can be installed in StreamPipes at runtime.</p>
+<p>In this section, we describe our recommended minimum setup for locally setting up a development instance of StreamPipes needed to develop, run and test new pipeline elements.</p>
+<h2><a class="anchor" aria-hidden="true" id="ide--required-dev-tools"></a><a href="#ide--required-dev-tools" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 [...]
+<p>StreamPipes does not have specific requirements on the IDE - so feel free to choose the IDE of your choice.
+The only requirements in terms of development tools are that you have Java 8 and Maven installed.</p>
+<h2><a class="anchor" aria-hidden="true" id="streampipes-cli-docker-based-local-streampipes-instance"></a><a href="#streampipes-cli-docker-based-local-streampipes-instance" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22- [...]
+<p>In order to quickly test developed pipeline elements without needing to install all services required by StreamPipes, we provide a CLI tool that allows you to selectively start StreamPipes components.
+The CLI tool allows to switch to several templates (based on docker-compose) depending on the role.</p>
+<p>The documentation on the usage of the CLI tool is available <a href="/docs/docs/0.70.0/extend-cli.html">here</a>.</p>
+<h2><a class="anchor" aria-hidden="true" id="override-the-sp_host-variable"></a><a href="#override-the-sp_host-variable" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 [...]
+<p>By default, the backend/core of StreamPipes registers itself within StreamPipes' service discovery mechanism using an auto-discovered hostname.
+Usually, this will be an IP address from the Docker network, which is not resolvable from outside. Therefore, for local development you need to override the hostname with an IP address which is accessible from your local host where you develop extensions.
+When using the CLI, open the CLI folder <code>installer/cli</code>, navigate to <code>deploy/standalone/backend</code>, open the <code>docker-compose.dev.yml</code> file and add the SP_HOST env variable, e.g.</p>
+<pre><code class="hljs"><span class="hljs-symbol">version:</span> <span class="hljs-string">"3.4"</span>
+<span class="hljs-symbol">services:</span>
+<span class="hljs-symbol"> backend:</span>
+<span class="hljs-symbol"> ports:</span>
+ - <span class="hljs-string">"8030:8030"</span>
+<span class="hljs-symbol"> environment:</span>
+ - SP_HOST=host.docker.internal
+</code></pre>
+<p>Note that host.docker.internal will work as an alias under Docker for Desktop on Windows and Mac, but not on Linux or M1. In this case, provide a resolvable hostname or IP address manually.</p>
+<h2><a class="anchor" aria-hidden="true" id="starter-projects"></a><a href="#starter-projects" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
+<p>Now, once you've started the development instance, you are ready to develop your very first pipeline element.
+Instead of starting from scratch, we recommend using our provided maven archetypes:</p>
+<h3><a class="anchor" aria-hidden="true" id="maven-archetypes"></a><a href="#maven-archetypes" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
+<p>Create the Maven archetype as described in the <a href="/docs/docs/0.70.0/extend-archetypes.html">Maven Archetypes</a> guide.</p>
+<h3><a class="anchor" aria-hidden="true" id="examples"></a><a href="#examples" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 [...]
+<p>We provide several examples that explain the usage of some concepts in this <a href="https://github.com/apache/incubator-streampipes-examples">Github repo</a>.</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/deploy-security.html"><span class="arrow-prev">← </span><span>Security</span></a><a class="docs-next button" href="/docs/docs/0.70.0/extend-cli.html"><span class="function-name-prevnext">StreamPipes CLI</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#ide--required-dev-tools">IDE & required dev tools</a> [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/extend-tutorial-data-processors.html b/docs/docs/0.70.0/extend-tutorial-data-processors.html
new file mode 100644
index 00000000..f01ec0fa
--- /dev/null
+++ b/docs/docs/0.70.0/extend-tutorial-data-processors.html
@@ -0,0 +1,357 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Tutorial: Data Processors · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="In this tutorial, we will add a new data processor using the standalone wrapper."/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" con [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Tutorial: Data Processors</h1></header><article><div><span><p>In this tutorial, we will add a new data processor using the standalone wrapper.</p>
+<p>From an architectural point of view, we will create a self-contained service that includes the description of the data processor and a an implementation.</p>
+<h2><a class="anchor" aria-hidden="true" id="objective"></a><a href="#objective" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>We are going to create a new data processor that realized a simple geofencing algorithm - we detect vehicles that enter a specified radius around a user-defined location.
+This pipeline element will be a generic element that works with any event stream that provides geospatial coordinates in form of a latitude/longitude pair.</p>
+<p>The algorithm outputs every location event once the position has entered the geofence.</p>
+<div class="admonition note">
+<div class="admonition-title">Note</div>
+<p>The implementation in this tutorial is pretty simple - our processor will fire an event every time the GPS location is inside the geofence.
+ In a real-world application, you would probably want to define a pattern that recognizes the _first_ event a vehicle enters the geofence.<br/>
+ This can be easily done using a CEP library.</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="project-setup"></a><a href="#project-setup" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Instead of creating a new project from scratch, we recommend to use the Maven archetype to create a new project skeleton (streampipes-archetype-extensions-jvm).
+Enter the following command in a command line of your choice (Apache Maven needs to be installed):</p>
+<pre><code class="hljs">mvn archetype:generate \
+<span class="hljs-attribute">-DarchetypeGroupId</span>=org.apache.streampipes <span class="hljs-attribute">-DarchetypeArtifactId</span>=streampipes-archetype-extensions-jvm \
+<span class="hljs-attribute">-DarchetypeVersion</span>=0.69.0 <span class="hljs-attribute">-DgroupId</span>=my.groupId \
+<span class="hljs-attribute">-DartifactId</span>=my-example <span class="hljs-attribute">-DclassNamePrefix</span>=MyExample <span class="hljs-attribute">-DpackageName</span>=mypackagename
+</code></pre>
+<p>You will see a project structure similar to the structure shown in the <a href="/docs/docs/0.70.0/extend-archetypes.html">archetypes</a> section.</p>
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p>Besides the basic project skeleton, the sample project also includes an example Dockerfile you can use to package your application into a Docker container.</p>
+</div>
+<p>Now you're ready to create your first data processor for StreamPipes!</p>
+<h2><a class="anchor" aria-hidden="true" id="adding-data-processor-requirements"></a><a href="#adding-data-processor-requirements" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5 [...]
+<p>First, we will add a new stream requirement.
+Create a new class <code>GeofencingProcessor</code> which should look as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">package</span> org.apache.streampipes.pe.example;
+
+<span class="hljs-keyword">import</span> org.apache.streampipes.commons.exceptions.SpRuntimeException;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.DataProcessorType;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.graph.DataProcessorDescription;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.runtime.Event;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.builder.ProcessingElementBuilder;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.builder.StreamRequirementsBuilder;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.EpRequirements;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.Labels;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.Locales;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.OutputStrategies;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.utils.Assets;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.context.EventProcessorRuntimeContext;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.routing.SpOutputCollector;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.standalone.ProcessorParams;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.standalone.StreamPipesDataProcessor;
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">GeofencingProcessor</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">StreamPipesDataProcessor</span> </span>{
+
+ <span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> String LATITUDE_CENTER = <span class="hljs-string">"latitude-center"</span>;
+ <span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> String LONGITUDE_CENTER = <span class="hljs-string">"longitude-center"</span>;
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.tutorial-geofencing"</span>)
+ .category(DataProcessorType.ENRICH)
+ .withAssets(Assets.DOCUMENTATION, Assets.ICON)
+ .build();
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onInvocation</span><span class="hljs-params">(ProcessorParams parameters, SpOutputCollector spOutputCollector, EventProcessorRuntimeContext runtimeContext)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event, SpOutputCollector collector)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onDetach</span><span class="hljs-params">()</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+
+ }
+}
+
+
+</code></pre>
+<p>In this class, we need to implement three methods: The <code>declareModel</code> method is used to define abstract stream requirements such as event properties that must be present in any input stream that is later connected to the element using the StreamPipes UI.
+The second method, <code>onInvocation</code> is triggered once a pipeline is started. Finally, the <code>onEvent</code> method</p>
+<p>Similar to data sources, the SDK provides a builder class to generate the description for data processors.
+Delete the content within the <code>declareModel</code> method and add the following lines to the <code>declareModel</code> method:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.tutorial.geofencing"</span>, <span class="hljs-string">"Geofencing"</span>, <span class="hljs-string">"A simple geofencing data processor"</span>)
+</code></pre>
+<p>This creates a new data processor with the ID, title and description assigned to the element builder.
+Next, we add some <em>stream requirements</em> to the description. As we'd like to develop a generic pipeline element that works with any event that provides a lat/lng pair, we define two stream requirements as stated below:</p>
+<pre><code class="hljs css language-java">.requiredStream(StreamRequirementsBuilder
+ .create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.domainPropertyReq(Geo.lat),
+ Labels.from(<span class="hljs-string">"latitude-field"</span>, <span class="hljs-string">"Latitude"</span>, <span class="hljs-string">"The event "</span> +
+ <span class="hljs-string">"property containing the latitude value"</span>), PropertyScope.MEASUREMENT_PROPERTY)
+ .requiredPropertyWithUnaryMapping(EpRequirements.domainPropertyReq(Geo.lng),
+ Labels.from(<span class="hljs-string">"longitude-field"</span>, <span class="hljs-string">"Longitude"</span>, <span class="hljs-string">"The event "</span> +
+ <span class="hljs-string">"property containing the longitude value"</span>), PropertyScope.MEASUREMENT_PROPERTY)
+ .build())
+</code></pre>
+<p>The first line, <code>.requiredStream()</code> defines that we want a data processor with exactly one input stream. Adding more stream requirements would create elements with multiple input connectors in StreamPipes.
+Stream requirements can be assigned by using the <code>StreamRequirementsBuilder</code> class.
+In our example, we define two requirements, so-called <em>domain property requirements</em>. In contrast to <em>data type requirements</em> where we'd expect an event property with a field of a specific data type (e.g., float), domain property requirements expect a specific domain property, e.g., from a vocabulary such as the WGS84 Geo vocab.</p>
+<p>Once a pipeline is deployed, we are interested in the actual field (and its field name) that contains the latitude and longitude values.
+In some cases, there might me more than one field that satisfies a property requirement and we would like users to select the property the geofencing component should operate on.
+Therefore, our example uses the method <code>requiredPropertyWithUnaryMapping</code>, which will map a requirement to a real event property of an input stream and let the user choose the appropriate field in the StreamPipes UI when pipelines are defined.</p>
+<p>Finally, the <code>PropertyScope</code> indicates that the required property is a measurement value (in contrast to a dimension value). This allows us later to provide improved user guidance in the pipeline editor.</p>
+<p>Besides requirements, users should be able to define the center coordinate of the Geofence and the size of the fence defined as a radius around the center in meters.
+The radius can be defined by adding a simple required text field to the description:</p>
+<pre><code class="hljs css language-java">.requiredIntegerParameter(<span class="hljs-string">"radius"</span>, <span class="hljs-string">"Geofence Size"</span>, <span class="hljs-string">"The size of the circular geofence in meters."</span>, <span class="hljs-number">0</span>, <span class="hljs-number">1000</span>, <span class="hljs-number">1</span>)
+</code></pre>
+<p>Similar to mapping properties, text parameters have an internalId (radius), a label and a description.
+In addition, we can assign a <em>value specification</em> to the parameter indicating the value range we support.
+Our example supports a radius value between 0 and 1000 with a granularity of 1.
+In the StreamPipes UI, a required text parameter is rendered as a text input field, in case we provide an optional value specification, a slider input is automatically generated.</p>
+<p>Such user-defined parameters are called <em>static properties</em>. There are many different types of static properties (see
+the <a href="/docs/docs/0.70.0/extend-sdk-static-properties.html">Processor SDK</a> for an overview).</p>
+<p>In this example, we'll further add two very simple input fields to let users provide latitude and longitude of the geofence center.</p>
+<p>Add the following line to the <code>declareModel</code> method:</p>
+<pre><code class="hljs css language-java"> .requiredFloatParameter(Labels.from(LATITUDE_KEY, <span class="hljs-string">"Latitude"</span>, <span class="hljs-string">"The latitude value"</span>))
+ .requiredFloatParameter(Labels.from(LONGITUDE_KEY, <span class="hljs-string">"Longitude"</span>, <span class="hljs-string">"The longitude value"</span>))
+
+</code></pre>
+<p>Now we need to define the output of our Geofencing pipeline element.
+As explained in the first section, the element should fire every time some geo-located entity arrives within the defined geofence.
+Therefore, the processor outputs the same schema as it receives as an input.
+Although we don't know the exact input right now as it depends on the stream users connect in StreamPipes when creating pipelines, we can define an <em>output strategy</em> as follows:</p>
+<pre><code class="hljs css language-java">.outputStrategy(OutputStrategies.keep())
+</code></pre>
+<p>This defines a <em>KeepOutputStrategy</em>, i.e., the input event schema is not modified by the processor.
+There are many more output strategies you can define depending on the functionality you desire, e.g., <em>AppendOutput</em> for defining a processor that enriches events or <em>CustomOutput</em> in case you would like users to select the output by themselves.</p>
+<p>That's it! We've now defined input requirements, required user input and an output strategy.
+In the next section, you will learn how to extract these parameters once the pipeline element is invoked after a pipeline was created.</p>
+<h2><a class="anchor" aria-hidden="true" id="pipeline-element-invocation"></a><a href="#pipeline-element-invocation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 1 [...]
+<p>Once users start a pipeline that uses our geofencing component, the <em>onInvocation</em> method in our class is called. The class <code>ProcessorParams</code> includes convenient access to user-configured parameters a users has selected in the pipeline editor and information on the acutal streams that are connected to the pipeline element.</p>
+<p>Next, we are interested in the fields of the input event stream that contains the latitude and longitude value we would like to compute against the geofence center location as follows:</p>
+<pre><code class="hljs css language-java">String latitudeFieldName = extractor.mappingPropertyValue(<span class="hljs-string">"latitude-field"</span>);
+String longitudeFieldName = extractor.mappingPropertyValue(<span class="hljs-string">"longitude-field"</span>);
+</code></pre>
+<p>We use the same <code>internalId</code> we've used to define the mapping property requirements in the <code>declareModel</code> method.</p>
+<p>Next, for extracting the geofence center coordinates, add to class variables centerLatitude and centerLongitude and assign the selected values using the following statements:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">this</span>.centerLatitude = parameters.extractor().singleValueParameter(LATITUDE_CENTER, Float<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+<span class="hljs-keyword">this</span>.centerLongitude = parameters.extractor().singleValueParameter(LONGITUDE_CENTER, Float<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+</code></pre>
+<p>The radius value can be extracted as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">int</span> radius = parameters.extractor().singleValueParameter(<span class="hljs-string">"radius"</span>, Float<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+</code></pre>
+<p>Great! That's all we need to describe a data processor for usage in StreamPipes. Your controller class should look as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">package</span> org.apache.streampipes.pe.example;
+
+<span class="hljs-keyword">import</span> org.apache.streampipes.commons.exceptions.SpRuntimeException;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.DataProcessorType;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.graph.DataProcessorDescription;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.runtime.Event;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.schema.PropertyScope;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.builder.ProcessingElementBuilder;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.builder.StreamRequirementsBuilder;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.EpRequirements;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.Labels;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.Locales;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.OutputStrategies;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.utils.Assets;
+<span class="hljs-keyword">import</span> org.apache.streampipes.vocabulary.Geo;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.context.EventProcessorRuntimeContext;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.routing.SpOutputCollector;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.standalone.ProcessorParams;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.standalone.StreamPipesDataProcessor;
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">GeofencingProcessor</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">StreamPipesDataProcessor</span> </span>{
+
+ <span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> String LATITUDE_CENTER = <span class="hljs-string">"latitude-center"</span>;
+ <span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> String LONGITUDE_CENTER = <span class="hljs-string">"longitude-center"</span>;
+
+ <span class="hljs-keyword">private</span> <span class="hljs-keyword">float</span> centerLatitude;
+ <span class="hljs-keyword">private</span> <span class="hljs-keyword">float</span> centerLongitude;
+ <span class="hljs-keyword">private</span> <span class="hljs-keyword">int</span> radius;
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataProcessorDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> ProcessingElementBuilder.create(<span class="hljs-string">"org.streampipes.tutorial-geofencing"</span>)
+ .category(DataProcessorType.ENRICH)
+ .withAssets(Assets.DOCUMENTATION, Assets.ICON)
+ .withLocales(Locales.EN)
+ .requiredStream(StreamRequirementsBuilder
+ .create()
+ .requiredPropertyWithUnaryMapping(EpRequirements.domainPropertyReq(Geo.lat),
+ Labels.from(<span class="hljs-string">"latitude-field"</span>, <span class="hljs-string">"Latitude"</span>, <span class="hljs-string">"The event "</span> +
+ <span class="hljs-string">"property containing the latitude value"</span>), PropertyScope.MEASUREMENT_PROPERTY)
+ .requiredPropertyWithUnaryMapping(EpRequirements.domainPropertyReq(Geo.lng),
+ Labels.from(<span class="hljs-string">"longitude-field"</span>, <span class="hljs-string">"Longitude"</span>, <span class="hljs-string">"The event "</span> +
+ <span class="hljs-string">"property containing the longitude value"</span>), PropertyScope.MEASUREMENT_PROPERTY)
+ .build())
+ .outputStrategy(OutputStrategies.keep())
+ .requiredIntegerParameter(<span class="hljs-string">"radius"</span>, <span class="hljs-string">"Geofence Size"</span>, <span class="hljs-string">"The size of the circular geofence in meters."</span>, <span class="hljs-number">0</span>, <span class="hljs-number">1000</span>, <span class="hljs-number">1</span>)
+ .requiredFloatParameter(Labels.from(LATITUDE_CENTER, <span class="hljs-string">"Latitude"</span>, <span class="hljs-string">"The latitude value"</span>))
+ .requiredFloatParameter(Labels.from(LONGITUDE_CENTER, <span class="hljs-string">"Longitude"</span>, <span class="hljs-string">"The longitude value"</span>))
+ .build();
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onInvocation</span><span class="hljs-params">(ProcessorParams parameters, SpOutputCollector spOutputCollector, EventProcessorRuntimeContext runtimeContext)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+ <span class="hljs-keyword">this</span>.centerLatitude = parameters.extractor().singleValueParameter(LATITUDE_CENTER, Float<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+ <span class="hljs-keyword">this</span>.centerLongitude = parameters.extractor().singleValueParameter(LONGITUDE_CENTER, Float<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+ <span class="hljs-keyword">this</span>.radius = parameters.extractor().singleValueParameter(<span class="hljs-string">"radius"</span>, Integer<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event, SpOutputCollector collector)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onDetach</span><span class="hljs-params">()</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+
+ }
+}
+
+
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="adding-an-implementation"></a><a href="#adding-an-implementation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-. [...]
+<p>Everything we need to do now is to add an implementation.</p>
+<p>Open the class <code>GeofencingProcessor.java</code> and add the following piece of code to the onEvent method, which realizes the Geofencing functionality:</p>
+<pre><code class="hljs css language-java">
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event, SpOutputCollector collector)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+ <span class="hljs-keyword">float</span> latitude = event.getFieldBySelector(latitudeFieldName).getAsPrimitive().getAsFloat();
+ <span class="hljs-keyword">float</span> longitude = event.getFieldBySelector(longitudeFieldName).getAsPrimitive().getAsFloat();
+
+ <span class="hljs-keyword">float</span> distance = distFrom(latitude, longitude, centerLatitude, centerLongitude);
+
+ <span class="hljs-keyword">if</span> (distance <= radius) {
+ collector.collect(event);
+ }
+ }
+
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">float</span> <span class="hljs-title">distFrom</span><span class="hljs-params">(<span class="hljs-keyword">float</span> lat1, <span class="hljs-keyword">float</span> lng1, <span class="hljs-keyword">float</span> lat2, <span class="hljs-keyword">float</span> lng2)</span> </span>{
+ <span class="hljs-keyword">double</span> earthRadius = <span class="hljs-number">6371000</span>;
+ <span class="hljs-keyword">double</span> dLat = Math.toRadians(lat2-lat1);
+ <span class="hljs-keyword">double</span> dLng = Math.toRadians(lng2-lng1);
+ <span class="hljs-keyword">double</span> a = Math.sin(dLat/<span class="hljs-number">2</span>) * Math.sin(dLat/<span class="hljs-number">2</span>) +
+ Math.cos(Math.toRadians(lat1)) * Math.cos(Math.toRadians(lat2)) *
+ Math.sin(dLng/<span class="hljs-number">2</span>) * Math.sin(dLng/<span class="hljs-number">2</span>);
+ <span class="hljs-keyword">double</span> c = <span class="hljs-number">2</span> * Math.atan2(Math.sqrt(a), Math.sqrt(<span class="hljs-number">1</span>-a));
+ <span class="hljs-keyword">return</span> (<span class="hljs-keyword">float</span>) (earthRadius * c);
+ }
+
+}
+</code></pre>
+<p>We won't go into details here as this isn't StreamPipes-related code, but in general the class extracts latitude and longitude fields from the input event (which is provided as a map data type) and calculates the distance between the geofence center and these coordinates.
+If the distance is below the given radius, the event is forwarded to the next operator.</p>
+<p>See the <a href="/docs/docs/0.70.0/extend-sdk-event-model.html">event model</a> guide to learn how to extract parameters from events.</p>
+<h2><a class="anchor" aria-hidden="true" id="registering-the-pipeline-element"></a><a href="#registering-the-pipeline-element" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13. [...]
+<p>The final step is to register the data processor in the <code>Init</code> method. Add the following line to the <code>SpServiceDefinitionBuilder</code>:</p>
+<pre><code class="hljs css language-java"> .registerPipelineElement(<span class="hljs-keyword">new</span> GeofencingProcessor())
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="starting-the-service"></a><a href="#starting-the-service" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1 [...]
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p>Once you start the service, it will register in StreamPipes with the hostname. The hostname will be auto-discovered and should work out-of-the-box.
+In some cases, the detected hostname is not resolvable from within a container (where the core is running). In this case, provide a SP_HOST environment variable to override the auto-discovery.
+</p>
+</div>
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p> The default port of all pipeline element services as defined in the `create` method is port 8090.
+ If you'd like to run multiple services at the same time on your development machine, change the port here. As an alternative, you can also provide an env variable `SP_PORT` which overrides the port settings. This is useful to use different configs for dev and prod environments.
+</p>
+</div>
+<p>Now we are ready to start our service!</p>
+<p>Configure your IDE to provide an environment variable called <code>SP_DEBUG</code> with value <code>true</code> when starting the project.</p>
+<p>Execute the main method in the class <code>Init</code> we've just created, open a web browser and navigate to <a href="http://localhost:8090">http://localhost:8090</a> (or the port you have assigned).</p>
+<p>You should see something as follows:</p>
+<p><img src="/docs/img/tutorial-processors/pe-overview-flink.PNG" alt="Pipeline Element Container Overview"></p>
+<p>The services automatically registers itself in StreamPipes.
+To install the just created element, open the StreamPipes UI and follow the manual provided in the <a href="/docs/docs/0.70.0/use-install-pipeline-elements.html">user guide</a>.</p>
+<h2><a class="anchor" aria-hidden="true" id="read-more"></a><a href="#read-more" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>Congratulations! You've just created your first data processor for StreamPipes.
+There are many more things to explore and data processors can be defined in much more detail using multiple wrappers.
+Follow our <a href="/docs/docs/0.70.0/extend-sdk-static-properties.html">SDK guide</a> to see what's possible!</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/extend-tutorial-data-sources.html"><span class="arrow-prev">← </span><span>Tutorial: Data Sources</span></a><a class="docs-next button" href="/docs/docs/0.70.0/extend-tutorial-data-sinks.html"><span>Tutorial: Data Sinks</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#objective">Objective</a></li><li><a href [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/extend-tutorial-data-sinks.html b/docs/docs/0.70.0/extend-tutorial-data-sinks.html
new file mode 100644
index 00000000..ce50d115
--- /dev/null
+++ b/docs/docs/0.70.0/extend-tutorial-data-sinks.html
@@ -0,0 +1,269 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Tutorial: Data Sinks · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="In this tutorial, we will add a new data sink using the standalone wrapper."/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/ [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Tutorial: Data Sinks</h1></header><article><div><span><p>In this tutorial, we will add a new data sink using the standalone wrapper.</p>
+<p>From an architectural point of view, we will create a self-contained service that includes the description of the data sink and a corresponding implementation.</p>
+<h2><a class="anchor" aria-hidden="true" id="objective"></a><a href="#objective" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>We are going to create a new data sink that calls an external HTTP endpoint to forward data to an external service.</p>
+<p>For each incoming event, an external service is invoked using an HTTP POST request. In this example, we'll call an endpoint provided by <a href="https://requestbin.com/">RequestBin</a>.
+To setup your own endpoint, go to <a href="https://requestbin.com/">https://requestbin.com/</a> and click "Create a request bin". Copy the URL of the newly created endpoint.</p>
+<h2><a class="anchor" aria-hidden="true" id="project-setup"></a><a href="#project-setup" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Instead of creating a new project from scratch, we recommend to use the Maven archetype to create a new project skeleton (streampipes-archetype-extensions-jvm).
+Enter the following command in a command line of your choice (Apache Maven needs to be installed):</p>
+<pre><code class="hljs">mvn archetype:generate <span class="hljs-attribute">-DarchetypeGroupId</span>=org.apache.streampipes \
+<span class="hljs-attribute">-DarchetypeArtifactId</span>=streampipes-archetype-extensions-jvm <span class="hljs-attribute">-DarchetypeVersion</span>=0.68.0 \
+<span class="hljs-attribute">-DgroupId</span>=org.streampipes.tutorial <span class="hljs-attribute">-DartifactId</span>=sink-tutorial <span class="hljs-attribute">-DclassNamePrefix</span>=Rest <span class="hljs-attribute">-DpackageName</span>=mypackage
+</code></pre>
+<p>You will see a project structure similar to the structure shown in the <a href="/docs/docs/0.70.0/extend-archetypes.html">archetypes</a> section.</p>
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p>Besides the basic project skeleton, the sample project also includes an example Dockerfile you can use to package your application into a Docker container.</p>
+</div>
+<p>Now you're ready to create your first data sink for StreamPipes!</p>
+<h2><a class="anchor" aria-hidden="true" id="adding-data-sink-requirements"></a><a href="#adding-data-sink-requirements" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 [...]
+<p>First, we will add a new stream requirement.
+Create a class <code>RestSink</code> which should look as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">package</span> org.apache.streampipes.pe.example;
+
+<span class="hljs-keyword">import</span> org.apache.streampipes.commons.exceptions.SpRuntimeException;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.DataSinkType;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.graph.DataSinkDescription;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.runtime.Event;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.schema.PropertyScope;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.builder.DataSinkBuilder;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.builder.StreamRequirementsBuilder;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.EpRequirements;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.Labels;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.Locales;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.utils.Assets;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.context.EventSinkRuntimeContext;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.standalone.SinkParams;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.standalone.StreamPipesDataSink;
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">RestSink</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">StreamPipesDataSink</span> </span>{
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataSinkDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> DataSinkBuilder.create(<span class="hljs-string">"org.streampipes.tutorial.pe.sink.rest"</span>)
+ .category(DataSinkType.NOTIFICATION)
+ .withAssets(Assets.DOCUMENTATION, Assets.ICON)
+ .withLocales(Locales.EN)
+ .requiredStream(StreamRequirementsBuilder
+ .create()
+ .requiredPropertyWithNaryMapping(EpRequirements.anyProperty(), Labels.withId(
+ <span class="hljs-string">"fields-to-send"</span>), PropertyScope.NONE)
+ .build())
+ .build();
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onInvocation</span><span class="hljs-params">(SinkParams parameters, EventSinkRuntimeContext runtimeContext)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onDetach</span><span class="hljs-params">()</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+
+ }
+}
+
+
+</code></pre>
+<p>In this class, we need to implement three methods: The <code>declareModel</code> method is used to define abstract stream requirements such as event properties that must be present in any input stream that is later connected to the element using the StreamPipes UI.
+The second method, <code>onInvocation</code> is called once a pipeline using this sink is started. The third method, <code>onEvent</code>, is called for every incoming event.</p>
+<p>The <code>declareModel</code> method describes the properties of our data sink:</p>
+<ul>
+<li><code>category</code> defines a category for this sink.</li>
+<li><code>withAssets</code> denotes that we will provide an external documentation file and an icon, which can be found in the <code>resources</code> folder</li>
+<li><code>withLocales</code> defines that we will provide an external language file, also available in the <code>resources</code> folder</li>
+<li><code>requiredStream</code> defines requirements any input stream connected to this sink must provide. In this case, we do not have any specific requirements, we just forward all incoming events to the REST sink. However, we want to let the user display a list of available fields from the connected input event, where users can select a subset. This is defined by defining a Mapping from the empty requirement. This will later on render a selection dialog in the pipeline editor.</li>
+</ul>
+<p>The <code>onInvocation</code> method is called when a pipeline containing the sink is started. Once a pipeline is started, we would like to extract user-defined parameters.
+In this example, we simply extract the fields selected by users that should be forwarded to the REST sink. Finally, we return a new configured event sink containing the parameters.</p>
+<h2><a class="anchor" aria-hidden="true" id="pipeline-element-invocation"></a><a href="#pipeline-element-invocation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 1 [...]
+<p>Once users start a pipeline that uses our geofencing component, the <em>onInvocation</em> method in our class is called. The class <code>SinkParams</code> includes a graph that contains information on the configuration parameters a users has selected in the pipeline editor and information on the acutal streams that are connected to the pipeline element.</p>
+<h2><a class="anchor" aria-hidden="true" id="adding-an-implementation"></a><a href="#adding-an-implementation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-. [...]
+<p>Now we'll add a proper implementation (i.e., the Rest call executed for every incoming event) to the following methods:</p>
+<p>Our final class should look as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">package</span> org.apache.streampipes.pe.example;
+
+<span class="hljs-keyword">import</span> com.google.common.base.Charsets;
+<span class="hljs-keyword">import</span> org.apache.http.client.fluent.Request;
+<span class="hljs-keyword">import</span> org.apache.http.entity.StringEntity;
+<span class="hljs-keyword">import</span> org.apache.streampipes.commons.exceptions.SpRuntimeException;
+<span class="hljs-keyword">import</span> org.apache.streampipes.dataformat.SpDataFormatDefinition;
+<span class="hljs-keyword">import</span> org.apache.streampipes.dataformat.json.JsonDataFormatDefinition;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.DataSinkType;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.graph.DataSinkDescription;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.runtime.Event;
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.schema.PropertyScope;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.builder.DataSinkBuilder;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.builder.StreamRequirementsBuilder;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.EpRequirements;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.Labels;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.helpers.Locales;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sdk.utils.Assets;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.context.EventSinkRuntimeContext;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.standalone.SinkParams;
+<span class="hljs-keyword">import</span> org.apache.streampipes.wrapper.standalone.StreamPipesDataSink;
+<span class="hljs-keyword">import</span> org.slf4j.Logger;
+<span class="hljs-keyword">import</span> org.slf4j.LoggerFactory;
+
+<span class="hljs-keyword">import</span> java.io.IOException;
+<span class="hljs-keyword">import</span> java.util.List;
+<span class="hljs-keyword">import</span> java.util.Map;
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">RestSink</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">StreamPipesDataSink</span> </span>{
+
+ <span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> Logger LOG = LoggerFactory.getLogger(RestSink<span class="hljs-class">.<span class="hljs-keyword">class</span>)</span>;
+
+ <span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> String REST_ENDPOINT_URI = YOUR_REQUEST_BIN_URL;
+ <span class="hljs-keyword">private</span> List<String> fieldsToSend;
+ <span class="hljs-keyword">private</span> SpDataFormatDefinition dataFormatDefinition;
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> DataSinkDescription <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ ...
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onInvocation</span><span class="hljs-params">(SinkParams parameters, EventSinkRuntimeContext runtimeContext)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+ <span class="hljs-keyword">this</span>.dataFormatDefinition = <span class="hljs-keyword">new</span> JsonDataFormatDefinition();
+ <span class="hljs-keyword">this</span>.fieldsToSend = parameters.extractor().mappingPropertyValues(<span class="hljs-string">"fields-to-send"</span>);
+
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onEvent</span><span class="hljs-params">(Event event)</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+ Map<String, Object> outEventMap = event.getSubset(fieldsToSend).getRaw();
+ <span class="hljs-keyword">try</span> {
+ String json = <span class="hljs-keyword">new</span> String(dataFormatDefinition.fromMap(outEventMap));
+ Request.Post(REST_ENDPOINT_URI).body(<span class="hljs-keyword">new</span> StringEntity(json, Charsets.UTF_8)).execute();
+ } <span class="hljs-keyword">catch</span> (SpRuntimeException e) {
+ LOG.error(<span class="hljs-string">"Could not parse incoming event"</span>);
+ } <span class="hljs-keyword">catch</span> (IOException e) {
+ LOG.error(<span class="hljs-string">"Could not reach endpoint at {}"</span>, REST_ENDPOINT_URI);
+ }
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onDetach</span><span class="hljs-params">()</span> <span class="hljs-keyword">throws</span> SpRuntimeException </span>{
+
+ }
+}
+
+</code></pre>
+<p>The only class variable you need to change right now is the REST_ENDPOINT_URL. Change this url to the URL provided by your request bin.
+In the <code>ònEvent</code> method, we use a helper method to get a subset of the incoming event.
+Finally, we convert the resulting <code>Map</code> to a JSON string and call the endpoint.</p>
+<h2><a class="anchor" aria-hidden="true" id="preparing-the-service"></a><a href="#preparing-the-service" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2 [...]
+<p>The final step is to register the sink as a pipeline element.</p>
+<p>Go to the class <code>Init</code> and register the sink:</p>
+<pre><code class="hljs css language-java">.registerPipelineElement(<span class="hljs-keyword">new</span> RestSink())
+</code></pre>
+<h2><a class="anchor" aria-hidden="true" id="starting-the-service"></a><a href="#starting-the-service" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1 [...]
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p>Once you start the service, it will register in StreamPipes with the hostname. The hostname will be auto-discovered and should work out-of-the-box.
+In some cases, the detected hostname is not resolvable from within a container (where the core is running). In this case, provide a SP_HOST environment variable to override the auto-discovery.
+</p>
+</div>
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p> The default port of all pipeline element services as defined in the `create` method is port 8090.
+ If you'd like to run multiple services at the same time on your development machine, change the port here. As an alternative, you can also provide an env variable `SP_PORT` which overrides the port settings. This is useful to use different configs for dev and prod environments.
+</p>
+</div>
+<p>Now we are ready to start our service!</p>
+<p>Configure your IDE to provide an environment variable called <code>SP_DEBUG</code> with value <code>true</code> when starting the project.</p>
+<p>Execute the main method in the class <code>Init</code> we've just created, open a web browser and navigate to <a href="http://localhost:8090">http://localhost:8090</a> (or the port you have assigned).</p>
+<p>The services automatically registers itself in StreamPipes.</p>
+<p>To install the created element, open the StreamPipes UI and follow the manual provided in the <a href="/docs/docs/0.70.0/use-install-pipeline-elements.html">user guide</a>.</p>
+<h2><a class="anchor" aria-hidden="true" id="read-more"></a><a href="#read-more" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>Congratulations! You've just created your first data sink for StreamPipes.
+There are many more things to explore and data sinks can be defined in much more detail using multiple wrappers.
+Follow our <a href="../dev-guide-sdk-guide-sinks">SDK guide</a> to see what's possible!</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/extend-tutorial-data-processors.html"><span class="arrow-prev">← </span><span>Tutorial: Data Processors</span></a><a class="docs-next button" href="/docs/docs/0.70.0/extend-sdk-event-model.html"><span>SDK: Event Model</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#objective">Objective</a></li><li><a href=" [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/extend-tutorial-data-sources.html b/docs/docs/0.70.0/extend-tutorial-data-sources.html
new file mode 100644
index 00000000..1f52ea5e
--- /dev/null
+++ b/docs/docs/0.70.0/extend-tutorial-data-sources.html
@@ -0,0 +1,240 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Tutorial: Data Sources · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="In this tutorial, we will add a new data source consisting of a single data stream. The source will be provided as a standalone component (i.e., the description will be a [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Tutorial: Data Sources</h1></header><article><div><span><p>In this tutorial, we will add a new data source consisting of a single data stream. The source will be provided as a standalone component (i.e., the description will be accessible through an integrated web server).</p>
+<h2><a class="anchor" aria-hidden="true" id="objective"></a><a href="#objective" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>We are going to create a new data stream that is produced by a GPS sensor installed in a delivery vehicle.
+The sensor produces a continuous stream of events that contain the current timestamp, the current lat/lng position of the vehicle and the plate number of the vehicle.
+Events are published in a JSON format as follows:</p>
+<pre><code class="hljs css language-json">{
+ <span class="hljs-attr">"timestamp"</span> : <span class="hljs-number">145838399</span>,
+ <span class="hljs-attr">"latitude"</span> : <span class="hljs-number">37.04</span>,
+ <span class="hljs-attr">"longitude"</span> : <span class="hljs-number">17.04</span>,
+ <span class="hljs-attr">"plateNumber"</span> : <span class="hljs-string">"KA-AB 123"</span>
+}
+</code></pre>
+<p>These events are published to a Kafka broker using the topic <code>org.streampipes.tutorial.vehicle</code>.</p>
+<p>In the following section, we show how to describe this stream in a form that allows you to import and use it in StreamPipes.</p>
+<h2><a class="anchor" aria-hidden="true" id="project-setup"></a><a href="#project-setup" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Instead of creating a new project from scratch, we recommend to use the Maven archetype to create a new project skeleton (streampipes-archetype-extensions-jvm).
+Enter the following command in a command line of your choice (Apache Maven needs to be installed):</p>
+<pre><code class="hljs">mvn archetype:generate \
+<span class="hljs-attribute">-DarchetypeGroupId</span>=org.apache.streampipes <span class="hljs-attribute">-DarchetypeArtifactId</span>=streampipes-archetype-extensions-jvm \
+<span class="hljs-attribute">-DarchetypeVersion</span>=0.69.0 <span class="hljs-attribute">-DgroupId</span>=my.groupId \
+<span class="hljs-attribute">-DartifactId</span>=my-source <span class="hljs-attribute">-DclassNamePrefix</span>=MySource <span class="hljs-attribute">-DpackageName</span>=mypackagename
+</code></pre>
+<p>You will see a project structure similar to the structure shown in the <a href="/docs/docs/0.70.0/extend-archetypes.html">archetypes</a> section.</p>
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p>Besides the basic project skeleton, the sample project also includes an example Dockerfile you can use to package your application into a Docker container.
+</p>
+</div>
+<h2><a class="anchor" aria-hidden="true" id="adding-a-data-stream-description"></a><a href="#adding-a-data-stream-description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13. [...]
+<p>Now we will add a new data stream definition.
+First, create a new class <code>MyVehicleStream</code> which should look as follows:</p>
+<pre><code class="hljs css language-java">
+<span class="hljs-keyword">package</span> org.apache.streampipes.pe.example;
+
+<span class="hljs-keyword">import</span> org.apache.streampipes.model.SpDataStream;
+<span class="hljs-keyword">import</span> org.apache.streampipes.sources.AbstractAdapterIncludedStream;
+
+<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">MyVehicleStream</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">AbstractAdapterIncludedStream</span> </span>{
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> SpDataStream <span class="hljs-title">declareModel</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> <span class="hljs-keyword">null</span>;
+ }
+
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">executeStream</span><span class="hljs-params">()</span> </span>{
+
+ }
+}
+</code></pre>
+<p>This class extends the class <code>AbstractAdapterIncludedStream</code>, which indicates that this source continuously produces data (configured in the <code>executeStream()</code> method.
+In contrast, the class <code>AbstractAlreadyExistingStream</code> indicates that we only want to describe an already existing stream (e.g., a stream that already sends data to an existing Kafka broker).</p>
+<p>Next, we will add the definition of the data stream. Add the following code inside of the <code>declareModel</code> method:</p>
+<pre><code class="hljs css language-java"><span class="hljs-keyword">return</span> DataStreamBuilder.create(<span class="hljs-string">"org.streampipes.tutorial.vehicle.position"</span>, <span class="hljs-string">"Vehicle Position"</span>, <span class="hljs-string">"An event stream "</span> +
+ <span class="hljs-string">"that produces current vehicle positions"</span>)
+</code></pre>
+<p>This line creates a new instance of the SDK's <code>DataStreamBuilder</code> by providing three basic parameters:
+The first parameter must be a unique identifier of your data stream.
+The second and third parameters indicate a label and a description of your stream.
+These values will later be used in the StreamPipes UI to display stream details in a human-readable manner.</p>
+<p>Next, we will add the properties as stated above to the stream definition by adding the following lines:</p>
+<pre><code class="hljs css language-java">.property(EpProperties.timestampProperty(<span class="hljs-string">"timestamp"</span>))
+.property(EpProperties.stringEp(Labels.from(<span class="hljs-string">"plate-number"</span>, <span class="hljs-string">"Plate Number"</span>, <span class="hljs-string">"Denotes the plate number of the vehicle"</span>), <span class="hljs-string">"plateNumber"</span>, <span class="hljs-string">"http://my.company/plateNumber"</span>))
+.property(EpProperties.doubleEp(Labels.from(<span class="hljs-string">"latitude"</span>, <span class="hljs-string">"Latitude"</span>, <span class="hljs-string">"Denotes the latitude value of the vehicle's position"</span>), <span class="hljs-string">"latitude"</span>, Geo.lat))
+.property(EpProperties.doubleEp(Labels.from(<span class="hljs-string">"longitude"</span>, <span class="hljs-string">"Longitude"</span>, <span class="hljs-string">"Denotes the longitude value of the vehicle's position"</span>), <span class="hljs-string">"longitude"</span>, Geo.lng))
+</code></pre>
+<p>These four <em>event properties</em> compose our <em>event schema</em>. An event property must, at least, provide the following attributes:</p>
+<ul>
+<li><strong>Runtime Name</strong>. The runtime name indicates the key of the property at runtime, e.g., if our JSON message contains a structure such as <code>{"plateNumber" : "KA-F 123"}</code>, the runtime name must be <code>plateNumber</code>.</li>
+<li><strong>Runtime Type</strong>. An event property must have a primitive type (we will later see how to model more complex properties such as lists and nested properties).
+The type must be an instance of <code>XMLSchema</code> primitives, however, the SDK provides convenience methods to provide the property type.</li>
+<li><strong>Domain Property</strong>. The domain property indicates the semantics of the event property. For instance, the <code>latitude</code> property is linked to the <code>http://www.w3.org/2003/01/geo/wgs84_pos#lat</code> property of the WGS84 vocabulary.
+The domain property should be an URI as part of an existing or domain-specific vocabulary. The SDK provides convenience methods for popuplar vocabularies (e.g., Schema.org, Dolce or WGS84).</li>
+</ul>
+<p>In order to complete the minimum required specification of an event stream, we need to provide information on the transport format and protocol of the data stream at runtime.</p>
+<p>This can be achieved by extending the builder with the respective properties:</p>
+<pre><code class="hljs css language-java">.format(Formats.jsonFormat())
+.protocol(Protocols.kafka(<span class="hljs-string">"localhost"</span>, <span class="hljs-number">9094</span>, <span class="hljs-string">"TOPIC_SHOULD_BE_CHANGED"</span>))
+.build();
+</code></pre>
+<p>Set <code>org.streampipes.tutorial.vehicle</code> as your new topic by replacing the term ``TOPIC_SHOULD_BE_CHANGED`.</p>
+<p>In this example, we defined that the data stream consists of events in a JSON format and that Kafka is used as a message broker to transmit events.
+The last build() method call triggers the construction of the data stream definition.</p>
+<p>That's it! In the next section, we will connect the data stream to a source and inspect the generated RDF description.</p>
+<h2><a class="anchor" aria-hidden="true" id="creating-some-dummy-data"></a><a href="#creating-some-dummy-data" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-. [...]
+<p>Let's assume our stream should produce some random values that are sent to StreamPipes. We'll add a very simple data simulator to the <code>executeStream</code> method as follows:</p>
+<pre><code class="hljs css language-java"><span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">executeStream</span><span class="hljs-params">()</span> </span>{
+
+ SpKafkaProducer producer = <span class="hljs-keyword">new</span> SpKafkaProducer(<span class="hljs-string">"localhost:9094"</span>, <span class="hljs-string">"my-topic"</span>, Collections.emptyList());
+ Random random = <span class="hljs-keyword">new</span> Random();
+ Runnable runnable = () -> {
+ <span class="hljs-keyword">for</span> (;;) {
+ JsonObject jsonObject = <span class="hljs-keyword">new</span> JsonObject();
+ jsonObject.addProperty(<span class="hljs-string">"timestamp"</span>, System.currentTimeMillis());
+ jsonObject.addProperty(<span class="hljs-string">"plateNumber"</span>, <span class="hljs-string">"KA-FZ 1"</span>);
+ jsonObject.addProperty(<span class="hljs-string">"latitude"</span>, random.nextDouble());
+ jsonObject.addProperty(<span class="hljs-string">"longitude"</span>, random.nextDouble());
+
+ producer.publish(jsonObject.toString());
+
+ <span class="hljs-keyword">try</span> {
+ TimeUnit.SECONDS.sleep(<span class="hljs-number">1</span>);
+ } <span class="hljs-keyword">catch</span> (InterruptedException e) {
+ e.printStackTrace();
+ }
+
+ }
+ };
+
+ <span class="hljs-keyword">new</span> Thread(runnable).start();
+ }
+</code></pre>
+<p>Change the topic and the URL of your Kafka broker (as stated in the controller).</p>
+<h2><a class="anchor" aria-hidden="true" id="registering-the-data-stream"></a><a href="#registering-the-data-stream" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 1 [...]
+<p>You need to register the stream in the service definition. Open the <code>Init</code> class and register the <code>MyVehicleStream</code>:</p>
+<pre><code class="hljs css language-java">
+ <span class="hljs-meta">@Override</span>
+ <span class="hljs-function"><span class="hljs-keyword">public</span> SpServiceDefinition <span class="hljs-title">provideServiceDefinition</span><span class="hljs-params">()</span> </span>{
+ <span class="hljs-keyword">return</span> SpServiceDefinitionBuilder.create(<span class="hljs-string">"org.apache.streampipes"</span>,
+ <span class="hljs-string">"human-readable service name"</span>,
+ <span class="hljs-string">"human-readable service description"</span>, <span class="hljs-number">8090</span>)
+ .registerPipelineElement(<span class="hljs-keyword">new</span> ExampleDataProcessor())
+ .registerPipelineElement(<span class="hljs-keyword">new</span> ExampleDataSink())
+ .registerPipelineElement(<span class="hljs-keyword">new</span> MyVehicleStream())
+ .registerMessagingFormats(
+ <span class="hljs-keyword">new</span> JsonDataFormatFactory(),
+ <span class="hljs-keyword">new</span> CborDataFormatFactory(),
+ <span class="hljs-keyword">new</span> SmileDataFormatFactory(),
+ <span class="hljs-keyword">new</span> FstDataFormatFactory())
+ .registerMessagingProtocols(
+ <span class="hljs-keyword">new</span> SpKafkaProtocolFactory(),
+ <span class="hljs-keyword">new</span> SpJmsProtocolFactory(),
+ <span class="hljs-keyword">new</span> SpMqttProtocolFactory())
+ .build();
+ }
+
+</code></pre>
+<p>You can remove the other two example classes if you want.</p>
+<h2><a class="anchor" aria-hidden="true" id="starting-the-service"></a><a href="#starting-the-service" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1 [...]
+<div class="admonition tip">
+<div class="admonition-title">Tip</div>
+<p>Once you start the service, it will register in StreamPipes with the hostname. The hostname will be auto-discovered and should work out-of-the-box.
+In some cases, the detected hostname is not resolvable from within a container (where the core is running). In this case, provide a SP_HOST environment variable to override the auto-discovery.
+</p>
+</div>
+<p>Now we are ready to start our first container!</p>
+<p>Execute the main method in the class <code>Init</code>, open a web browser and navigate to <a href="http://localhost:8090">http://localhost:8090</a>, or change the port according to the value of the <code>SP_PORT</code> variable in the env file.</p>
+<p>Configure your IDE to provide an environment variable called <code>SP_DEBUG</code> with value <code>true</code> when starting the project.</p>
+<p>You should see something as follows:</p>
+<p><img src="/docs/img/tutorial-sources/pe-overview.PNG" alt="Pipeline Element Container Overview"></p>
+<p>Click on the link of the data source to see the generated description of the pipeline element.</p>
+<p><img src="/docs/img/tutorial-sources/pe-rdf.PNG" alt="Pipeline Element description"></p>
+<p>The container automatically registers itself in StreamPipes.</p>
+<p>To install the just created element, open the StreamPipes UI and install the source over the <code>Install Pipeline Elements</code> section.</p>
+<h2><a class="anchor" aria-hidden="true" id="read-more"></a><a href="#read-more" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>Congratulations! You've just created your first pipeline element for StreamPipes.
+There are many more things to explore and data sources can be defined in much more detail.</p>
+</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/docs/0.70.0/extend-first-processor.html"><span class="arrow-prev">← </span><span>Your first data processor</span></a><a class="docs-next button" href="/docs/docs/0.70.0/extend-tutorial-data-processors.html"><span>Tutorial: Data Processors</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#objective">Objective</a></li><li> [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/faq-common-problems.html b/docs/docs/0.70.0/faq-common-problems.html
new file mode 100644
index 00000000..b4e36e5c
--- /dev/null
+++ b/docs/docs/0.70.0/faq-common-problems.html
@@ -0,0 +1,131 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Common Problems · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="* Windows 10: Consul, Kafka, Zookeeper, or Kafka-Rest did not start"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta proper [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ var coll = document.getElementsByClassName('collapsible');
+ var checkActiveCategory = true;
+ for (var i = 0; i < coll.length; i++) {
+ var links = coll[i].nextElementSibling.getElementsByTagName('*');
+ if (checkActiveCategory){
+ for (var j = 0; j < links.length; j++) {
+ if (links[j].classList.contains('navListItemActive')){
+ coll[i].nextElementSibling.classList.toggle('hide');
+ coll[i].childNodes[1].classList.toggle('rotate');
+ checkActiveCategory = false;
+ break;
+ }
+ }
+ }
+
+ coll[i].addEventListener('click', function() {
+ var arrow = this.childNodes[1];
+ arrow.classList.toggle('rotate');
+ var content = this.nextElementSibling;
+ content.classList.toggle('hide');
+ });
+ }
+
+ document.addEventListener('DOMContentLoaded', function() {
+ createToggler('#navToggler', '#docsNav', 'docsSliderActive');
+ createToggler('#tocToggler', 'body', 'tocActive');
+
+ var headings = document.querySelector('.toc-headings');
+ headings && headings.addEventListener('click', function(event) {
+ var el = event.target;
+ while(el !== headings){
+ if (el.tagName === 'A') {
+ document.body.classList.remove('tocActive');
+ break;
+ } else{
+ el = el.parentNode;
+ }
+ }
+ }, false);
+
+ function createToggler(togglerSelector, targetSelector, className) {
+ var toggler = document.querySelector(togglerSelector);
+ var target = document.querySelector(targetSelector);
+
+ if (!toggler) {
+ return;
+ }
+
+ toggler.onclick = function(event) {
+ event.preventDefault();
+
+ target.classList.toggle(className);
+ };
+ }
+ });
+ </script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Common Problems</h1></header><article><div><span><ul>
+<li>Windows 10: Consul, Kafka, Zookeeper, or Kafka-Rest did not start</li>
+<li>Linux / OSX: Consul does not start</li>
+<li>Run StreamPipes in a VM in Windows</li>
+<li>Only few processors are available in the pipeline editor</li>
+<li>No data is shown in the live dashbord</li>
+<li>Windows 10: Should I use settings windows containers or docker containers?</li>
+<li>Configurations are not deleted</li>
+<li>Help us to improve StreamPipes and this documentation</li>
+<li>Docker Network already used</li>
+</ul>
+<h2><a class="anchor" aria-hidden="true" id="windows-10-consul-kafka-zookeeper-or-kafka-rest-did-not-start"></a><a href="#windows-10-consul-kafka-zookeeper-or-kafka-rest-did-not-start" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-. [...]
+<p><strong>Problem:</strong> You get an error message similar to: <code>ERROR: for consul Cannot start service consul: b'driver failed programming external connectivity on endpoint sp-test_consul_1 (eae0457fc03c1364b8e81a6e155ca4b95ee1e1d01bb3c1aa9dd5192bdcb7b91a): Error starting userland proxy: mkdir /port/tcp:0.0.0.0:8600:tcp:172.30.0.9:8600: input/output error</code></p>
+<p><strong>Solution:</strong> To resolve this problem, stop StreamPipes with <code>streampipes stop</code> and restart Docker via the Docker settings in the task bar.
+After Docker was restarted, run <code>streampipes start</code>.</p>
+<h2><a class="anchor" aria-hidden="true" id="consul-does-not-start"></a><a href="#consul-does-not-start" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2 [...]
+<p><strong>Problem:</strong> After starting StreamPipes with <code>streampipes start</code>, there is an error with Consul:</p>
+<p><strong>Solution:</strong> To resolve this, execute <code>streampipes stop</code>, wait a minute and start it again with <code>streampipes start</code>. If you've installed an old version of StreamPipes (before the installer was available), make sure that no network suffixed with <code>spnet</code> exists in Docker. Type <code>docker network ls</code> to check and <code>docker network rm NETWORK_NAME</code> to remove the existing network before running the installer.</p>
+<h2><a class="anchor" aria-hidden="true" id="run-streampipes-in-a-vm-in-windows"></a><a href="#run-streampipes-in-a-vm-in-windows" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5 [...]
+<p><strong>Problem:</strong> StreamPipes does not work properly with Docker under Windows 8 or earlier versions.</p>
+<p><strong>Solution:</strong> We do support virtual machines (VMs), but if you run them under Windows, there might be problems with docker and its network configurations.
+Please use Windows 10, OSX or Linux.
+You can also use a VM from a cloud provider to test StreamPipes.</p>
+<h2><a class="anchor" aria-hidden="true" id="only-few-processors-are-available-in-the-pipeline-editor"></a><a href="#only-few-processors-are-available-in-the-pipeline-editor" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.2 [...]
+<p><strong>Problem:</strong> In the Pipeline Editor, only a few processors can be used in pipelines.</p>
+<p><strong>Solution:</strong> In the demo/desktop version, we only integrated a few processors. To ensure that you can easily try out StreamPipes (even on your laptop),
+we tried to make it as lightweight as possible. If you are interested in more sophisticated algorithms, pleas contact us.</p>
+<h2><a class="anchor" aria-hidden="true" id="no-data-is-shown-in-the-live-dashboard"></a><a href="#no-data-is-shown-in-the-live-dashboard" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1. [...]
+<p><strong>Problem:</strong> The live dashboard does not show any data.</p>
+<p><strong>Solution:</strong> If this is the case, your IP is probably configured wrong.
+You can reinstall the system by running <code>streampipes clean</code> and then <code>streampipes start</code> again.
+This will delete all StreamPipes configurations. StreamPipes is designed as a server application and requires a fixed IP.
+We created a version to easily run it on your laptop and test it, but on your laptop you usually get a new IP when you change the network.
+This problem only occurs in testing scenarios, in production scenarios the IP can also be changed manually without data loss.</p>
+<h2><a class="anchor" aria-hidden="true" id="windows-10-should-i-use-settings-windows-containers-or-docker-containers"></a><a href="#windows-10-should-i-use-settings-windows-containers-or-docker-containers" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C1 [...]
+<p><strong>Problem:</strong> StreamPipes does not work with Windows 10.</p>
+<p><strong>Solution:</strong> You should use docker containers. Go to the docker settings on our taks bar and select 'Switch to Docker containers'.</p>
+<h2><a class="anchor" aria-hidden="true" id="configurations-are-not-deleted"></a><a href="#configurations-are-not-deleted" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 1 [...]
+<p><strong>Problem:</strong> The configurations are not deleted from the host system. Even after manually removing the 'config/' folder StreamPipes settings are note deleted.
+Also the Consul settings are still there.</p>
+<p><strong>Solution:</strong> Probably Docker did not mount a volume in the 'config/' folder. You must delete the anonymous docker volumes manually. See in docker <a href="https://docs.docker.com/engine/reference/commandline/volume_rm/">documentation</a>.</p>
+<h2><a class="anchor" aria-hidden="true" id="docker-network-already-used"></a><a href="#docker-network-already-used" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 1 [...]
+<p><strong>Problem:</strong> When starting StreamPipes the error message: "Creating network 'streampipes-cli_spnet' with driver 'bridge' Pool overlaps with other one on this address space" is shown.</p>
+<p><strong>Solution:</strong> Delete old networks for example with "docker network prune".</p>
+<h2><a class="anchor" aria-hidden="true" id="help-us-to-improve-streampipes-and-this-documentation"></a><a href="#help-us-to-improve-streampipes-and-this-documentation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2. [...]
+<p>Help us to improve this section.
+If you have any problems with the system or with the documentation, do not hesitate to contact us.
+Our goal is to continuously improve StreamPipes.
+Your help and feedback is welcome.</p>
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#windows-10-consul-kafka-zookeeper-or-kafka-rest-did-not-start">Windows 10: Consul, Kafka, Zookeeper, or Kafka-Rest did not start</a></li><li><a href="#consul-does-not-start">Consul does not start</a></li><li><a href="#run-streampipes-in-a-vm-in-windows">Run StreamPipes in a VM in Windows</a></li><li><a href="#only-few-processors-are-available-in-the-pipe [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processor.geo.flink/org.apache.streampipes.processor.geo.flink.html b/docs/docs/0.70.0/org.apache.streampipes.processor.geo.flink/org.apache.streampipes.processor.geo.flink.html
new file mode 100644
index 00000000..f7af9e48
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processor.geo.flink/org.apache.streampipes.processor.geo.flink.html
@@ -0,0 +1,58 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Spatial Grid Enrichment · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Spatial Grid Enrichment · Apa [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processor.geo.flink/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Groups spatial events into cells of a given size
+Add a detailed description here</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Describe the configuration parameters here</p>
+<h3><a class="anchor" aria-hidden="true" id="1st-parameter"></a><a href="#1st-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="2nd-parameter"></a><a href="#2nd-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#1st-parameter">1st parameter</a></li><li><a href="#2nd-parameter">2nd parameter</a></li></ul></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" i [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processor.geo.jvm.geocoding/org.apache.streampipes.processor.geo.jvm.geocoding.html b/docs/docs/0.70.0/org.apache.streampipes.processor.geo.jvm.geocoding/org.apache.streampipes.processor.geo.jvm.geocoding.html
new file mode 100644
index 00000000..3495ae49
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processor.geo.jvm.geocoding/org.apache.streampipes.processor.geo.jvm.geocoding.html
@@ -0,0 +1,57 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Google Maps Geocoder · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Google Maps Geocoder · Apache St [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>This processor computes the latitude and longitude values from a location (a place name such as "Karlsruhe, Germany
+") and adds the result to the event.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Describe the configuration parameters here</p>
+<h3><a class="anchor" aria-hidden="true" id="1st-parameter"></a><a href="#1st-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="2nd-parameter"></a><a href="#2nd-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#1st-parameter">1st parameter</a></li><li><a href="#2nd-parameter">2nd parameter</a></li></ul></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" i [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processor.geo.jvm.reversegeocoding/org.apache.streampipes.processor.geo.jvm.reversegeocoding.html b/docs/docs/0.70.0/org.apache.streampipes.processor.geo.jvm.reversegeocoding/org.apache.streampipes.processor.geo.jvm.reversegeocoding.html
new file mode 100644
index 00000000..5896930c
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processor.geo.jvm.reversegeocoding/org.apache.streampipes.processor.geo.jvm.reversegeocoding.html
@@ -0,0 +1,56 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Reverse Geocoder · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Reverse Geocoder · Apache StreamPipe [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>This processor computes place name based on given lat/lng coordinates that are transmitted as fields from an event.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Describe the configuration parameters here</p>
+<h3><a class="anchor" aria-hidden="true" id="1st-parameter"></a><a href="#1st-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="2nd-parameter"></a><a href="#2nd-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#1st-parameter">1st parameter</a></li><li><a href="#2nd-parameter">2nd parameter</a></li></ul></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" i [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processor.geo.jvm.staticgeocoding/org.apache.streampipes.processor.geo.jvm.staticgeocoding.html b/docs/docs/0.70.0/org.apache.streampipes.processor.geo.jvm.staticgeocoding/org.apache.streampipes.processor.geo.jvm.staticgeocoding.html
new file mode 100644
index 00000000..25289fd2
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processor.geo.jvm.staticgeocoding/org.apache.streampipes.processor.geo.jvm.staticgeocoding.html
@@ -0,0 +1,58 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Static Google Maps Geocoder · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Static Google Maps Geocod [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>This processor computes the latitude and longitude values from a fixed location (a place name such as "Karlsruhe
+, Germany
+") and adds the result to the event.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Describe the configuration parameters here</p>
+<h3><a class="anchor" aria-hidden="true" id="1st-parameter"></a><a href="#1st-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="2nd-parameter"></a><a href="#2nd-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#1st-parameter">1st parameter</a></li><li><a href="#2nd-parameter">2nd parameter</a></li></ul></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" i [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processor.imageclassification.jvm.generic-image-classification/org.apache.streampipes.processor.imageclassification.jvm.generic-image-classification.html b/docs/docs/0.70.0/org.apache.streampipes.processor.imageclassification.jvm.generic-image-classification/org.apache.streampipes.processor.imageclassification.jvm.generic-image-classification.html
new file mode 100644
index 00000000..9f287d3d
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processor.imageclassification.jvm.generic-image-classification/org.apache.streampipes.processor.imageclassification.jvm.generic-image-classification.html
@@ -0,0 +1,58 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Generic Image Classification · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Generic Image Classifica [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processor.imageclassification.jvm.generic-image-classification/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Image + Classification Description (Generic Model)
+Add a detailed description here</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Describe the configuration parameters here</p>
+<h3><a class="anchor" aria-hidden="true" id="1st-parameter"></a><a href="#1st-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="2nd-parameter"></a><a href="#2nd-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#1st-parameter">1st parameter</a></li><li><a href="#2nd-parameter">2nd parameter</a></li></ul></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" i [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processor.imageclassification.jvm.image-enricher/org.apache.streampipes.processor.imageclassification.jvm.image-enricher.html b/docs/docs/0.70.0/org.apache.streampipes.processor.imageclassification.jvm.image-enricher/org.apache.streampipes.processor.imageclassification.jvm.image-enricher.html
new file mode 100644
index 00000000..4112caa4
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processor.imageclassification.jvm.image-enricher/org.apache.streampipes.processor.imageclassification.jvm.image-enricher.html
@@ -0,0 +1,58 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Image Enricher · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Image Enricher · Apache StreamPipes"/> [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processor.imageclassification.jvm.image-enricher/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Image Enrichment: Enriches an + image with + given bounding box coordinates
+Add a detailed description here</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Describe the configuration parameters here</p>
+<h3><a class="anchor" aria-hidden="true" id="1st-parameter"></a><a href="#1st-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="2nd-parameter"></a><a href="#2nd-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#1st-parameter">1st parameter</a></li><li><a href="#2nd-parameter">2nd parameter</a></li></ul></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" i [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processor.imageclassification.qrcode/org.apache.streampipes.processor.imageclassification.qrcode.html b/docs/docs/0.70.0/org.apache.streampipes.processor.imageclassification.qrcode/org.apache.streampipes.processor.imageclassification.qrcode.html
new file mode 100644
index 00000000..67e350f1
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processor.imageclassification.qrcode/org.apache.streampipes.processor.imageclassification.qrcode.html
@@ -0,0 +1,58 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>QR Code Reader · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="QR Code Reader · Apache StreamPipes"/> [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processor.imageclassification.qrcode/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>QR Code Reader: Detects a QR Code in an image
+Add a detailed description here</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Describe the configuration parameters here</p>
+<h3><a class="anchor" aria-hidden="true" id="1st-parameter"></a><a href="#1st-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="2nd-parameter"></a><a href="#2nd-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#1st-parameter">1st parameter</a></li><li><a href="#2nd-parameter">2nd parameter</a></li></ul></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" i [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processors.aggregation.flink.aggregation/org.apache.streampipes.processors.aggregation.flink.aggregation.html b/docs/docs/0.70.0/org.apache.streampipes.processors.aggregation.flink.aggregation/org.apache.streampipes.processors.aggregation.flink.aggregation.html
new file mode 100644
index 00000000..163f548e
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processors.aggregation.flink.aggregation/org.apache.streampipes.processors.aggregation.flink.aggregation.html
@@ -0,0 +1,64 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Aggregation · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Aggregation · Apache StreamPipes"/><meta [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processors.aggregation.flink.aggregation/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Performs different aggregation functions based on a sliding time window (e.g., average, sum, min, max)</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>The aggregation processor requires a data stream that has at least one field containing a numerical value.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="group-by"></a><a href="#group-by" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 [...]
+<p>The aaggregation function can be calculated separately (partitioned) by the selected field value.</p>
+<h3><a class="anchor" aria-hidden="true" id="output-every"></a><a href="#output-every" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83. [...]
+<p>The frequency in which aggregated values are sent in seconds.</p>
+<h3><a class="anchor" aria-hidden="true" id="time-window"></a><a href="#time-window" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>The size of the time window in seconds</p>
+<h3><a class="anchor" aria-hidden="true" id="aggregated-value"></a><a href="#aggregated-value" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2. [...]
+<p>The field used for calculating the aggregation value.</p>
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+<p>This processor appends the latest aggregated value to every input event that arrives.</p>
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#group-by">Group by</a></li><li><a href="#output-every">Output every</a></li><li><a href="#time-window">Time window</a></li><li><a href="#aggregated-value">Aggregated Value</a></li></ul> [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processors.aggregation.flink.eventcount/org.apache.streampipes.processors.aggregation.flink.eventcount.html b/docs/docs/0.70.0/org.apache.streampipes.processors.aggregation.flink.eventcount/org.apache.streampipes.processors.aggregation.flink.eventcount.html
new file mode 100644
index 00000000..6106fd7f
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processors.aggregation.flink.eventcount/org.apache.streampipes.processors.aggregation.flink.eventcount.html
@@ -0,0 +1,54 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Event Counter · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Event Counter · Apache StreamPipes"/><m [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Counts the number of events arriving within a time window. An event is emitted every time the time window expires.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Time Window: The scale and size of the time window.</p>
+<h3><a class="anchor" aria-hidden="true" id="1st-parameter"></a><a href="#1st-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="2nd-parameter"></a><a href="#2nd-parameter" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#1st-parameter">1st parameter</a></li><li><a href="#2nd-parameter">2nd parameter</a></li></ul></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" i [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processors.aggregation.flink.rate/org.apache.streampipes.processors.aggregation.flink.rate.html b/docs/docs/0.70.0/org.apache.streampipes.processors.aggregation.flink.rate/org.apache.streampipes.processors.aggregation.flink.rate.html
new file mode 100644
index 00000000..0e364d3a
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processors.aggregation.flink.rate/org.apache.streampipes.processors.aggregation.flink.rate.html
@@ -0,0 +1,57 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Event Rate · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Event Rate · Apache StreamPipes"/><meta pr [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processors.aggregation.flink.rate/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Computes the current event rate. Output is a number representing events per second.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>The event rate processor works with any stream and does not have any specific requirements.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="time-baseline"></a><a href="#time-baseline" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Time window size used for calculating the rate in seconds, also defines the output rate</p>
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#time-baseline">Time Baseline</a></li></ul></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/ [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.processor.math.mathop/org.apache.streampipes.processors.enricher.flink.processor.math.mathop.html b/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.processor.math.mathop/org.apache.streampipes.processors.enricher.flink.processor.math.mathop.html
new file mode 100644
index 00000000..8785846b
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.processor.math.mathop/org.apache.streampipes.processors.enricher.flink.processor.math.mathop.html
@@ -0,0 +1,62 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Math · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Math · Apache StreamPipes"/><meta property="og:t [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processors.enricher.flink.processor.math.mathop/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Performs calculations on event properties (+, -, *, /, %).</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>The math processor works with any event that has at least one field containing a numerical value.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="left-operand"></a><a href="#left-operand" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83. [...]
+<p>The field from the input event that should be used as the left operand.</p>
+<h3><a class="anchor" aria-hidden="true" id="right-operand"></a><a href="#right-operand" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>The field from the input event that should be used as the right operand.</p>
+<h3><a class="anchor" aria-hidden="true" id="operation"></a><a href="#operation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>The math operation that should be performed.</p>
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+<p>The processor appends the calculation result to each input event.</p>
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#left-operand">Left operand</a></li><li><a href="#right-operand">Right operand</a></li><li><a href="#operation">Operation</a></li></ul></li><li><a href="#output">Output</a></li></ul></na [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.processor.math.staticmathop/org.apache.streampipes.processors.enricher.flink.processor.math.staticmathop.html b/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.processor.math.staticmathop/org.apache.streampipes.processors.enricher.flink.processor.math.staticmathop.html
new file mode 100644
index 00000000..65c53ea9
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.processor.math.staticmathop/org.apache.streampipes.processors.enricher.flink.processor.math.staticmathop.html
@@ -0,0 +1,62 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Static Math · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Static Math · Apache StreamPipes"/><meta [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processors.enricher.flink.processor.math.staticmathop/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Performs calculation on an event property with a static value (+, -, *, /, %).</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>The math processor works with any event that has at least one field containing a numerical value.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="left-operand"></a><a href="#left-operand" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83. [...]
+<p>The field from the input event that should be used as the left operand.</p>
+<h3><a class="anchor" aria-hidden="true" id="right-operand-value"></a><a href="#right-operand-value" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.2 [...]
+<p>Specify the value of the right operand.</p>
+<h3><a class="anchor" aria-hidden="true" id="operation"></a><a href="#operation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>The math operation that should be performed.</p>
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+<p>The processor appends the calculation result to each input event.</p>
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#left-operand">Left operand</a></li><li><a href="#right-operand-value">Right operand value</a></li><li><a href="#operation">Operation</a></li></ul></li><li><a href="#output">Output</a></ [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.processor.trigonometry/org.apache.streampipes.processors.enricher.flink.processor.trigonometry.html b/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.processor.trigonometry/org.apache.streampipes.processors.enricher.flink.processor.trigonometry.html
new file mode 100644
index 00000000..22b3d5f6
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.processor.trigonometry/org.apache.streampipes.processors.enricher.flink.processor.trigonometry.html
@@ -0,0 +1,61 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Trigonometry Functions · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Trigonometry Functions · Apach [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processors.enricher.flink.processor.trigonometry/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Performs Trigonometric functions (sin, cos, tan) on event properties.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>The trigonometry processor works with any event that has at least one field containing a numerical value.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>Describe the configuration parameters here</p>
+<h3><a class="anchor" aria-hidden="true" id="alpha"></a><a href="#alpha" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09 [...]
+<p>The field that should be used for calculating the trigonometric function.</p>
+<h3><a class="anchor" aria-hidden="true" id="operation"></a><a href="#operation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>The trigonometric function that should be calculated.</p>
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+<p>The processor appends the calculation result to each input event.</p>
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#alpha">Alpha</a></li><li><a href="#operation">Operation</a></li></ul></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" id="footer"><section clas [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.processor.urldereferencing/org.apache.streampipes.processors.enricher.flink.processor.urldereferencing.html b/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.processor.urldereferencing/org.apache.streampipes.processors.enricher.flink.processor.urldereferencing.html
new file mode 100644
index 00000000..543177e7
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.processor.urldereferencing/org.apache.streampipes.processors.enricher.flink.processor.urldereferencing.html
@@ -0,0 +1,59 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>URL Dereferencing · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="URL Dereferencing · Apache StreamPi [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processors.enricher.flink.processor.urldereferencing/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Parses and appends the html page as a string to event.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>The URL Dereferencing processor requires an input stream that provides an input field of type 'string', representing
+the URL to dereference.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="url"></a><a href="#url" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.2 [...]
+<p>The field containing the URL to dereference.</p>
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+<p>The processor appends the extracted HTML page to each input event.</p>
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#url">URL</a></li></ul></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home">< [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.timestamp/org.apache.streampipes.processors.enricher.flink.timestamp.html b/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.timestamp/org.apache.streampipes.processors.enricher.flink.timestamp.html
new file mode 100644
index 00000000..4d4a2698
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.flink.timestamp/org.apache.streampipes.processors.enricher.flink.timestamp.html
@@ -0,0 +1,57 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Timestamp Enricher · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Timestamp Enricher · Apache Stream [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processors.enricher.flink.timestamp/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Appends the current time in ms to the event payload.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>The timestamp enricher works with any input event.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>(no further configuration required)</p>
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+<p>This processor appends the current system time to every input event.</p>
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.jvm.sizemeasure/org.apache.streampipes.processors.enricher.jvm.sizemeasure.html b/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.jvm.sizemeasure/org.apache.streampipes.processors.enricher.jvm.sizemeasure.html
new file mode 100644
index 00000000..ac51f190
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processors.enricher.jvm.sizemeasure/org.apache.streampipes.processors.enricher.jvm.sizemeasure.html
@@ -0,0 +1,40 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Size Measure · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<p align="center"> "/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Size Measure [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processors.enricher.jvm.sizemeasure/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Measures the size of an incoming event and appends this number to the event by serializing it.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>The size measure processor does not have any specific input requirements.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>You can specify if the size should be in Bytes, Kilobytes (1024 Bytes) or in Megabytes (1024 Kilobytes).</p>
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+<p>The size measure processor appends the size of the event (without the field, which is getting added) as a double. The rest of the event stays the same.</p>
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processors.filters.jvm.compose/org.apache.streampipes.processors.filters.jvm.compose.html b/docs/docs/0.70.0/org.apache.streampipes.processors.filters.jvm.compose/org.apache.streampipes.processors.filters.jvm.compose.html
new file mode 100644
index 00000000..39ea4494
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processors.filters.jvm.compose/org.apache.streampipes.processors.filters.jvm.compose.html
@@ -0,0 +1,58 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Compose · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Compose · Apache StreamPipes"/><meta property [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processors.filters.jvm.compose/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Merges two event streams. Any time, a new input event arrives, it is merged with the last input event from the other
+event stream and forwarded.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>The Compose processor does not have any specific input requirements.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<p>(no further configuration required)</p>
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+<p>The compose processor has a configurable output that can be selected by the user at pipeline modeling time.</p>
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processors.filters.jvm.enrich/org.apache.streampipes.processors.filters.jvm.enrich.html b/docs/docs/0.70.0/org.apache.streampipes.processors.filters.jvm.enrich/org.apache.streampipes.processors.filters.jvm.enrich.html
new file mode 100644
index 00000000..d94857b0
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processors.filters.jvm.enrich/org.apache.streampipes.processors.filters.jvm.enrich.html
@@ -0,0 +1,62 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Merge By Enrich · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Merge By Enrich · Apache StreamPipes" [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processors.filters.jvm.enrich/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Merges two data streams by enriching one of the streams with the properties of the other stream. The output frequency is the same as the frequency of the stream which is enriched.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>None</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<ul>
+<li>Select the stream which should be enriched with the properties of the other stream.
+<ul>
+<li>The last event of the stream is hold in state and each event of the other stream is enriched by the properties the user selected</li>
+</ul></li>
+</ul>
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+<p>The compose processor has a configurable output that can be selected by the user at pipeline modeling time.</p>
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processors.filters.jvm.merge/org.apache.streampipes.processors.filters.jvm.merge.html b/docs/docs/0.70.0/org.apache.streampipes.processors.filters.jvm.merge/org.apache.streampipes.processors.filters.jvm.merge.html
new file mode 100644
index 00000000..62217813
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processors.filters.jvm.merge/org.apache.streampipes.processors.filters.jvm.merge.html
@@ -0,0 +1,65 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Merge By Time · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Merge By Time · Apache StreamPipes"/><m [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processors.filters.jvm.merge/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>Merges two event streams by their timestamp.
+Two events of the different streams are merged when they occure to the same time</p>
+<p>The following figure shows how the events of the two data streams will be mergrged:</p>
+<p align="center">
+ <img width="width: 50%;" src="/docs/img/pipeline-elements/org.apache.streampipes.processors.filters.jvm.merge/merge_description.png" class="pe-image-documentation"/>
+</p>
+***
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>Each of the data streams needs a timestamp.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<ul>
+<li>For each stream a the timestamp property on which the merger is performed has to be selected</li>
+<li>The Time Interval describes the maximum value between two events to decide whether they are a match. To be a valid match the following function must be true: | timestamp_stream_1 - timestamp_stream_2 | < interval</li>
+</ul>
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+<p>The compose processor has a configurable output that can be selected by the user at pipeline modeling time.</p>
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a></li><li><a href="#output">Output</a></li></ul></nav></div><div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/docs/" class="nav-home"><img src="/docs/img/sp-logo-color.png" alt="Apache StreamPipes [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
+ inputSelector: '#search_input_react',
+ algoliaOptions: {}
+ });
+ </script></body></html>
\ No newline at end of file
diff --git a/docs/docs/0.70.0/org.apache.streampipes.processors.filters.jvm.numericalfilter/org.apache.streampipes.processors.filters.jvm.numericalfilter.html b/docs/docs/0.70.0/org.apache.streampipes.processors.filters.jvm.numericalfilter/org.apache.streampipes.processors.filters.jvm.numericalfilter.html
new file mode 100644
index 00000000..da9c1621
--- /dev/null
+++ b/docs/docs/0.70.0/org.apache.streampipes.processors.filters.jvm.numericalfilter/org.apache.streampipes.processors.filters.jvm.numericalfilter.html
@@ -0,0 +1,62 @@
+<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Numerical Filter · Apache StreamPipes</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!--"/><meta name="docsearch:version" content="0.70.0"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Numerical Filter · Apache StreamPipe [...]
+ document.addEventListener('DOMContentLoaded', function() {
+ addBackToTop(
+ {"zIndex":100}
+ )
+ });
+ </script><script src="/docs/js/scrollSpy.js"></script><link rel="stylesheet" href="/docs/css/prism.css"/><link rel="stylesheet" href="/docs/css/main.css"/><script src="/docs/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/docs/"><img class="logo" src="/docs/img/sp-logo-color-docs.png" alt="Apache StreamPipes"/></a><a href="/docs/versions.html"><h3>0.70.0</h3></a>< [...]
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+<p align="center">
+ <img src="/docs/img/pipeline-elements/org.apache.streampipes.processors.filters.jvm.numericalfilter/icon.png" width="150px;" class="pe-image-documentation"/>
+</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="description"></a><a href="#description" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42 [...]
+<p>The Numerical Filter processor filters numerical values based on a given threshold.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="required-input"></a><a href="#required-input" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0- [...]
+<p>The processor works with any input event that has one field containing a numerical value.</p>
+<hr>
+<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.8 [...]
+<h3><a class="anchor" aria-hidden="true" id="field"></a><a href="#field" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09 [...]
+<p>Specifies the field name where the filter operation should be applied on.</p>
+<h3><a class="anchor" aria-hidden="true" id="operation"></a><a href="#operation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.6 [...]
+<p>Specifies the filter operation that should be applied on the field.</p>
+<h3><a class="anchor" aria-hidden="true" id="threshold-value"></a><a href="#threshold-value" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 [...]
+<p>Specifies the threshold value.</p>
+<h2><a class="anchor" aria-hidden="true" id="output"></a><a href="#output" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2. [...]
+<p>The processor outputs the input event if it satisfies the filter expression.</p>
+</span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#description">Description</a></li><li><a href="#required-input">Required input</a></li><li><a href="#configuration">Configuration</a><ul class="toc-headings"><li><a href="#field">Field</a></li><li><a href="#operation">Operation</a></li><li><a href="#threshold-value">Threshold value</a></li></ul></li><li><a href="#output">Output</a></li></ul></nav></div><d [...]
+ document.addEventListener('keyup', function(e) {
+ if (e.target !== document.body) {
+ return;
+ }
+ // keyCode for '/' (slash)
+ if (e.keyCode === 191) {
+ const search = document.getElementById('search_input_react');
+ search && search.focus();
+ }
+ });
+ </script><script>
+ var search = docsearch({
+
+ apiKey: '0fedc89dddf2810657708b178e56ef02',
+ indexName: 'streampipes',
... 37563 lines suppressed ...