Skip to content

Commit

Permalink
RENAME NGSIArcgisFeatureTableSink -> NGSIArcGisSink in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fgalan committed Nov 19, 2020
1 parent de75f59 commit 262d543
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion cygnus-ngsi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ Detailed information regarding cygus-ngsi can be found in the [Installation and
<tr><td>Raw-snapsot analysis</td><td>1.6.0</td></tr>
<tr><td>NGSIOrionSink</td><td>First implementation</td><td>1.10.0</td></tr>
<tr><td>NGSIElasticsearchSink</td><td>First implementation</td><td>1.15.0</td></tr>
<tr><td>NGSIArcGisSink</td><td>First implementation</td><td>1.16.0</td></tr>
<tr><td>NGSIArcgisFeatureTableSink</td><td>First implementation (as NGSIArcGisSink)</td><td>1.16.0</td></tr>
<tr><td rowspan="2">NGSITestSink</td><td>First implementation</td><td>0.7.0</td></tr>
<tr><td>Batching mechanism</td><td>0.12.0</td></tr>
<tr><td rowspan="9">All sinks</td><td>Events TTL</td><td>0.4.1</td></tr>
Expand Down
2 changes: 1 addition & 1 deletion doc/cygnus-ngsi/flume_extensions_catalogue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* [NGSISTHSink](./ngsi_sth_sink.md)
* [NGSIOrionSink](./ngsi_orion_sink.md)
* [NGSIElasticsearchSink](./ngsi_elasticsearch_sink.md)
* [NGSIArcGisSink](./ngsi_arcgis_featuretable_sink.md)
* [NGSIArcgisFeatureTableSink](./ngsi_arcgis_featuretable_sink.md)
* [NGSITestSink](./ngsi_test_sink.md)
* Interceptors
* [GroupingInterceptor](./ngsi_grouping_interceptor.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ Content:
* [Important notes](#section2.2)
* [About batching](#section2.2.1)
* [Programmers guide](#section3)
* [`NGSIArcGisSink` class](#section3.1)
* [`NGSIArcgisFeatureTableSink` class](#section3.1)
* [Authentication and authorization](#section3.2)

## <a name="section1"></a>Functionality
`com.iot.telefonica.cygnus.sinks.NGSIArcGisSink` is a sink designed to persist NGSI-like context data events within an [ArcGis] (https://www.arcgis.com/home/index.html) feature table. Usually, such a context data is notified by a [Orion Context Broker](https://github.com/telefonicaid/fiware-orion) instance, but could be any other system speaking <i>NGSI language</i>.
`com.iot.telefonica.cygnus.sinks.NGSIArcgisFeatureTableSink` is a sink designed to persist NGSI-like context data events within an [ArcGis] (https://www.arcgis.com/home/index.html) feature table. Usually, such a context data is notified by a [Orion Context Broker](https://github.com/telefonicaid/fiware-orion) instance, but could be any other system speaking <i>NGSI language</i>.

Independently of the data generator, NGSI context data is always transformed into internal `NGSIEvent` objects at Cygnus sources. In the end, the information within these events must be mapped into specific ArcGis structures.

Expand Down Expand Up @@ -109,7 +109,7 @@ Feature table unique field:

## <a name="section2"></a>Administration guide
### <a name="section2.1"></a>Configuration
`NGSIArcGisSink` is configured through the following parameters:
`NGSIArcgisFeatureTableSink` is configured through the following parameters:

| Parameter | Mandatory | Default value | Comments |
|---|---|---|---|
Expand All @@ -132,7 +132,7 @@ A configuration example could be:
cygnus-ngsi.sinks = arcgis-sink
cygnus-ngsi.channels = arcgis-channel
...
cygnus-ngsi.sinks.arcgis-sink.type = com.telefonica.iot.cygnus.sinks.NGSIArcGisSink
cygnus-ngsi.sinks.arcgis-sink.type = com.telefonica.iot.cygnus.sinks.NGSIArcgisFeatureTableSink
cygnus-ngsi.sinks.arcgis-sink.channel = arcgis-channel
cygnus-ngsi.sinks.arcgis-sink.enable_name_mappings = true
cygnus-ngsi.sinks.arcgis-sink.enable_name_mappings = false
Expand Down Expand Up @@ -172,7 +172,7 @@ A `Batch` contains a set of `NGSIEvent` objects, which are the result of parsing

public void start();

This must be done at the `start()` method and not in the constructor since the invoking sequence is `NGSIArcGisSink()` (contructor), `configure()` and `start()`.
This must be done at the `start()` method and not in the constructor since the invoking sequence is `NGSIArcgisFeatureTableSink()` (contructor), `configure()` and `start()`.

public void configure(Context);

Expand Down
4 changes: 2 additions & 2 deletions docker/cygnus-ngsi/agent.conf
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,8 @@ cygnus-ngsi.sinks.elasticsearch-sink.ssl = false
#cygnus-ngsi.sinks.elasticsearch-sink.charset = UTF-8


# NGSIArcGisSink configuration
cygnus-ngsi.sinks.arcgis-sink.type = com.telefonica.iot.cygnus.sinks.NGSIArcGisSink
# NGSIArcgisFeatureTableSink configuration
cygnus-ngsi.sinks.arcgis-sink.type = com.telefonica.iot.cygnus.sinks.NGSIArcgisFeatureTableSink
cygnus-ngsi.sinks.arcgis-sink.channel = arcgis-channel
cygnus-ngsi.sinks.arcgis-sink.arcgis_url = https://<host>/<id>/ArcGIS/rest/services/
cygnus-ngsi.sinks.arcgis-sink.arcgis_username =
Expand Down
4 changes: 2 additions & 2 deletions docker/cygnus-ngsi/multisink_agent.conf
Original file line number Diff line number Diff line change
Expand Up @@ -384,8 +384,8 @@ cygnus-ngsi.sources.http-source-arcgis.interceptors.nmi.type = com.telefonica.io
cygnus-ngsi.sources.http-source-arcgis.interceptors.nmi.name_mappings_conf_file = /opt/apache-flume/conf/name_mappings.conf


# NGSIArcGisSink configuration
cygnus-ngsi.sinks.arcgis-sink.type = com.telefonica.iot.cygnus.sinks.NGSIArcGisSink
# NGSIArcgisFeatureTableSink configuration
cygnus-ngsi.sinks.arcgis-sink.type = com.telefonica.iot.cygnus.sinks.NGSIArcgisFeatureTableSink
cygnus-ngsi.sinks.arcgis-sink.channel = arcgis-channel
cygnus-ngsi.sinks.arcgis-sink.arcgis_url = https://<host>/<id>/ArcGIS/rest/services/
cygnus-ngsi.sinks.arcgis-sink.arcgis_username =
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ pages:
- 'NGSISTHSink': 'cygnus-ngsi/flume_extensions_catalogue/ngsi_sth_sink.md'
- 'NGSIOrionSink': 'cygnus-ngsi/flume_extensions_catalogue/ngsi_orion_sink.md'
- 'NGSIElasticsearchSink': 'cygnus-ngsi/flume_extensions_catalogue/ngsi_elasticsearch_sink.md'
- 'NGSIArcGisSink': 'cygnus-ngsi/flume_extensions_catalogue/ngsi_arcgis_featuretable_sink.md'
- 'NGSIArcgisFeatureTableSink': 'cygnus-ngsi/flume_extensions_catalogue/ngsi_arcgis_featuretable_sink.md'
- 'NGSITestSink': 'cygnus-ngsi/flume_extensions_catalogue/ngsi_test_sink.md'
- 'NGSIGroupingInterceptor': 'cygnus-ngsi/flume_extensions_catalogue/ngsi_grouping_interceptor.md'
- 'NGSINameMappingsInterceptor': 'cygnus-ngsi/flume_extensions_catalogue/ngsi_name_mappings_interceptor.md'
Expand Down

0 comments on commit 262d543

Please sign in to comment.