Contents
The Spotfire Streaming Data Point To Schema Operator is used to convert text based name field value pairs into StreamBase named schema.
This section describes the properties you can set for this operator, 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.
Operator: A read-only field that shows the formal name of the operator.
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 | Description |
|---|---|
| Name Field | The field in the input tuple that contains the name(s) to match against the field names in the output schema. The name field may be a single string or a list of strings. If the field is a list of strings, the value field must also be a list. |
| Value Field | The field in the input tuple that contains the value(s) to use. This field can be either a single data point or a list of single data point values. |
| Name Map Field | Optional. The field in the input tuple that contains the name to do schema field mapping. If this field is specified the operator ignores the name mapping property. |
| Enable Pass Through | If enabled the input tuple will be copied entirely to the output tuple. |
| Log Level | Controls the level of verbosity the adapter uses to send notifications to the console. This setting can be higher than the containing application's log level. If set lower, the system log level is used. Available values, in increasing order of verbosity, are: OFF, ERROR, WARN, INFO, DEBUG, TRACE. |
The Name Mapping tab is used to add mapping between the input names and the output
schema field names. You can use this in situations where the value found in the
name should be an invalid field StreamBase name. This allows you, for example, to
convert an input name of 1Test which is an invalid
StreamBase field name to a StreamBase field name of Test1 which is valid. In this example, the Test1 field should be present in the output schema defined on the
Edit Schema tab.
The Edit Schema tab is used to determine what fields are available to match with the input names.
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.
The Data Input port can consist of any schema and the properties of the operator will determine which fields are used for processing.