- Index

< Previous |  | Next >

# Using the Tuple to JSON Operator

## Introduction

The Tuple to JSON Java operator converts StreamBase tuples to JSON-encoded data. Each tuple enqueued to the operator results in a single JSON string emitted on its output port.

The operator's input schema determines the set of fields that appear in the generated JSON output. The hierarchy of the fields in the schema matches that of the elements in the JSON. Fields containing `null` are optionally discarded and may not appear in the JSON output. The incoming schema is duplicated to the output schema and a new user defined field is added which contains the JSON output.

## Properties View Settings

This section describes the properties you can set for a Tuple to JSON operator, using the various tabs of the Properties view in StreamBase Studio.

### General Tab

Name: Use this required field to specify or change the component's name, which must be unique in the current module. The name must contain only alphabetic characters, numbers, and underscores, and no hyphens or other special characters. The first character must be alphabetic or an underscore.

Operator: A read-only field that shows the formal name of the operator.

Class: Shows the fully qualified class name that implements the functionality of this operator. 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 with application: If this field is set to Yes (default) or to a module parameter that evaluates to `true`, this instance of this operator starts as part of the JVM engine that runs this EventFlow fragment. If this field is set to No or to a module parameter that evaluates to `false`, the operator instance is loaded with the engine, but does not start until you send an epadmin container resume command (or its sbadmin equivalent), or until you start the component with StreamBase Manager.

Enable Error Output Port: Select this check box 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 component's purpose and function. In the EventFlow canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.

### Operator Properties Tab

Property | Description
--- | ---
Output Field Name | The name of the field to be created in the output schema that contains the JSON converted from the incoming tuple.
Tuple Field | The field in the inbound tuple that contains the tuple to convert to JSON. Leave blank to convert the entire inbound tuple.
Enable Status Port | If enabled, the status port is made available to receive output status messages.
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.

### JSON Tab

Property | Description
--- | ---
Include Null Fields | Include null fields in the JSON output.
Timestamps as long | If enabled, timestamp fields are converted to a long value.
Timestamp Format | The format to use when converting timestamp values to a string.
Encode Sub Type | The type of transformation that should be used when there are sub-tuples to process. Map — Converting to a map adds field names to the JSON output. List — Converting to a list produces a compact JSON string but does not provide field names.

### Concurrency 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.

## Operator Ports

The operator has one input port and two output ports to communicate with the surrounding application.

The Tuple to JSON operator's ports are used as follows:

- TupleIn: The tuple to be converted to JSON. The TupleIn port can be any schema.

- DataOut: This output port contains all the fields of the TupleIn port with an added user defined field which contains the contents of the generated JSON string

- Status: A tuple is emitted on this port when an attempt to convert a tuple to an JSON message fails. The Status port has the following schema:

  - type, string: Contains the following value describing the type of event that occurred:

    - Convert

  - action, string: Contains the following value indicating the conversion failed:

    - Failed

  - object, string: Contains a string representation of the input tuple.

  - message, string: Contains a human-readable description of the conversion failure.

  - time, timestamp: Contains the time of the conversion failure.

  - inputTuple, tuple: Contains a copy of the input tuple.

## Related Topics

- Using the JSON to Tuple Operator

Back to Top ^