Contents
The Spotfire Streaming WikiMedia EventStreams Adapter processes continuous streams of structured event data from an EventStreams web service.
The EventStreams adapter provides access to arbitrary streams of data, including MediaWiki RecentChanges, Delete-page, Create-page, and others.
This section describes the properties you can set for this adapter, using the various tabs of the Properties view in StreamBase Studio.
Name: Use this required field to specify or change the name of this instance of this component. The name must be unique within the current EventFlow module. The name can contain alphanumeric characters, underscores, and escaped special characters. Special characters can be escaped as described in Identifier Naming Rules. The first character must be alphabetic or an underscore.
Adapter: A read-only field that shows the formal name of the adapter.
Class name: Shows the fully qualified class name that implements the functionality of this adapter. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.
Start options: This field provides a link to the Cluster Aware tab, where you configure the conditions under which this adapter starts.
Enable Error Output Port: Select this checkbox to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.
Description: Optionally, enter text to briefly describe the purpose and function of the component. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.
| Property | Type | Description |
|---|---|---|
| Enable Control Port | check box | Control historical starting position in each the requested streams. |
| Enable Status Port | check box | Control status output of the adapter.(CONNECT/DISCONNECT/ERROR) |
| Connect At Start-up | check box | Whether to connect when application starts. |
| Page-create EventStream | check box | Enable the page-create EventStream. |
| Page-move EventStream | check box | Enable the page-move EventStream. |
| Page-delete EventStream | check box | Enable the page-delete EventStream. |
| Recent-change EventStream | check box | Enable the recent-change EventStream. |
| Revision-create EventStream | check box | Enable the revision-create EventStream. |
| Page-undelete EventStream | check box | Enable the page-undelete EventStream. |
| Page-properties-change EventStream | check box | Enable the page-properties-change EventStream. |
| Log Level | INFO | Controls the level of verbosity the adapter uses to issue informational traces to the console. This setting is independent of the containing application's overall log level. Available values, in increasing order of verbosity, are: OFF, ERROR, WARN, INFO, DEBUG, TRACE. |
| Property | Type | Description |
|---|---|---|
| Recovering delay time(seconds) | int | Control historical starting position in each the requested streams. |
| Since Timestamp Format | String | Representation of dates and times is an international standard covering the exchange of date- and time-related data. |
| Timestamp Format | String | The format to use when converting timestamp values to a string. |
| Read time-out(seconds) | int | The value is the timeout to read a response. |
Use the settings in this tab to enable this operator or adapter for runtime start and stop conditions in a multi-node cluster. During initial development of the fragment that contains this operator or adapter, and for maximum compatibility with releases before 10.5.0, leave the Cluster start policy control in its default setting, Start with module.
Cluster awareness is an advanced topic that requires an understanding of StreamBase Runtime architecture features, including clusters, quorums, availability zones, and partitions. See Cluster Awareness Tab Settings on the Using Cluster Awareness page for instructions on configuring this tab.
Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.
Caution
Concurrency settings are not suitable for every application, and using these settings requires a thorough analysis of your application. For details, see Execution Order and Concurrency, which includes important guidelines for using the concurrency options.
Use the control port is used to send action commands to the adapter. Tuples enqueued on this port cause the adapter to connect or disconnect to certain EventStream, and can control the data starting point.
-
Command, string, the command to send to the adapter.
The values are:
-
Connect—Tells the adapter to connect to the URI specified in the input tuple.
-
Disconnect—Tells the adapter to disconnect from the URI specified in the input tuple (if a connection to that URI already exists).
-
-
EventStreamName, string. The EventStream Name to connect to.
The values are:
-
page-create
-
page-move
-
page-delete
-
recentchange
-
revision-create
-
page-undelete
-
page-properties-change
-
-
Since, string.
-
If given, this timestamp will be used as the historical starting position in each the requested streams.
-
-
The EventStream schema will be enabled when the corresponding EventStream property box is checked.
-
See available streams info: https://stream.wikimedia.org/?doc, https://github.com/wikimedia/mediawiki-event-schemas
| Field | Data Type | Description |
|---|---|---|
| status | string | The name of the status |
| time | timestamp | The date and time the status information was produced |
| info | list(name string, value string) | A list of Name-value pairs of details for the status, such as database name or error message |
All status messages that may be produced and the info list they provide:
-
connect on startup— Connection established on startup.
-
connect—Connect a stream event. Info list contains:
-
PortNumber—Status port number.
-
StreamName—The event stream name.
-
-
disconnect—Disconnect a stream event. Info list contains:
-
PortNumber—Status port number.
-
StreamName—The event stream name.
-
-
error—An error occurred. Info list contains:
-
ErrorMessage—A human readable error message.
-