WebSocket Server

The WebSocket Server origin is a multithreaded origin that listens on a WebSocket endpoint and processes the contents of all authorized WebSocket client requests. For information about supported versions, see Supported Systems and Versions.

The WebSocket Server origin can use multiple threads to enable parallel processing of data from multiple WebSocket clients. The origin can also send responses back to the origin system when used in a microservice pipeline.

Before you configure the origin, perform additional steps to configure the WebSocket clients.

When you configure the WebSocket Server origin, you specify the maximum number of concurrent requests to determine how many threads to use. You define the listening port, application ID, and the maximum message size. You can also configure SSL/TLS properties, including default transport protocols and cipher suites.

When you want the origin to send responses back to the origin system as part of a microservice pipeline, you configure the data format and other characteristics of the responses.

Tip: Data Collector provides two WebSocket origins to address different needs. For a quick comparison chart to help you choose the right one, see Comparing WebSocket Origins.

When a pipeline stops, the WebSocket Server origin notes where it stops reading. When the pipeline starts again, the origin continues processing from where it stopped by default. You can reset the origin to process all requested data.

Prerequisites

Before you run a pipeline with the WebSocket Server origin, complete the following prerequisites to configure the WebSocket clients.

Send Data to the Listening Port

Configure the WebSocket clients to send data to the WebSocket Server listening port.

When you configure the WebSocket Server origin, you define a listening port number where the origin listens for data. To pass data to the pipeline, configure each WebSocket client to send data to a URL that includes the listening port number.

Note: No other pipelines or processes can already be bound to the listening port. The listening port can be used only by a single pipeline.

Use the following format for the URL:

<ws | wss>://<sdc_hostname>:<listening_port>/

The URL includes the following components:

<ws | wss> - Use wss for secure WebSocket connections over HTTPS.
<sdc_hostname> - The Data Collector host name.
<listening_port> - The port number where the origin listens for data.

For example: wss://localhost:8080/

Include the Application ID in Requests

Configure the WebSocket clients to include the WebSocket Server application ID in each request.

When you configure the WebSocket Server origin, you define an application ID that is used to pass requests to the origin. All messages sent to the origin must include the application ID.

Include the application ID for each client request in one of the following ways:

In request headers

Add the following information to the request header for all WebSocket requests that you want the origin to process:

X-SDC-APPLICATION-ID: <application_ID>

For example:

X-SDC-APPLICATION-ID: sdc_http2kafka

In a query parameter in the URL

If you cannot configure the client request headers - for example if the requests are generated by another system - then configure each WebSocket client to send data to a URL that includes the application ID in a query parameter.

To include the application ID in a query parameter, enable the Application ID in URL property when you configure the origin. Then, include the application ID in a URL query parameter.

Use the following format for the URL:

<ws | wss>://<sdc_hostname>:<listening_port>/?sdcApplicationId=<application_ID>

The URL includes the following components:

<ws | wss> - Use wss for secure WebSocket connections over HTTPS.
<sdc_hostname> - The Data Collector host name.
<listening_port> - The port number where the origin listens for data.
<application_ID> - The application ID defined for the WebSocket Server origin.

For example: wss://localhost:8080/?sdcApplicationId=sdc_http2kafka

Multithreaded Processing

The WebSocket Server origin performs parallel processing and enables the creation of a multithreaded pipeline.

The WebSocket Server origin uses multiple concurrent threads based on the Max Concurrent Requests property. Each thread connects to the origin system, creates a batch of data, and passes the batch to an available pipeline runner.

A pipeline runner is a sourceless pipeline instance - an instance of the pipeline that includes all of the processors, executors, and destinations in the pipeline and handles all pipeline processing after the origin. Each pipeline runner processes one batch at a time, just like a pipeline that runs on a single thread. When the flow of data slows, the pipeline runners wait idly until they are needed, generating an empty batch at regular intervals. You can configure the Runner Idle Time pipeline property to specify the interval or to opt out of empty batch generation.

Multithreaded pipelines preserve the order of records within each batch, just like a single-threaded pipeline. But since batches are processed by different pipeline runners, the order that batches are written to destinations is not ensured.

For example, say you set the Max Concurrent Requests property to 5. When you start the pipeline, the origin creates five threads, and Data Collector creates a matching number of pipeline runners. Upon receiving data, the origin passes a batch to each of the pipeline runners for processing. In the batch, WebSocket Server includes only the WebSocket requests with the specified application ID.

At any given moment, the five pipeline runners can each process a batch, so this multithreaded pipeline processes up to five batches at a time. When incoming data slows, the pipeline runners sit idle, available for use as soon as the data flow increases.

For more information about multithreaded pipelines, see Multithreaded Pipeline Overview.

Generated Microservice Responses

In a microservice pipeline, the WebSocket Server origin can send a response back to the originating WebSocket client.

The generated response contains:

Records received from microservice destinations
Pipeline error records received when the pipeline is configured to use the Send Response to Origin pipeline error handling

The origin generates a single response for each batch of records received. The origin can generate the response in JSON or XML format. The response can include an envelope or only raw data.

Responses with an Envelope

When configured to send a response with an envelope, the origin generates a response that includes the status code, data from microservice destinations, error records from the pipeline, and the first error message. The generated response includes the following JSON keys or XML elements:

Response Key or Element	Value
httpStatusCode	The status code associated with the records in the response. If the records in the generated response share the same status code, the code is written to the httpStatusCode key or element. If the records have different status codes, the httpStatusCode is set to 207 for multiple statuses.
data	A list of records passed to the origin by the microservice destinations used in the pipeline.
error	A list of pipeline error records passed to the origin by the Send Response to Origin pipeline error handling.
errorMessage	The error message associated with the first error record in the response. Used only when the response includes error records.

For example, in JSON format, generated responses with envelopes have the following structure:

{
"httpStatusCode":<status code>,
"data":[<list of success records>],
"error":[<list of error records>],
"errorMessage": <error message, if any>
}

Raw Responses

When configured to send a raw response, the origin generates a response that contains either the list of records passed from the microservice destinations or the list of error records passed by the Send Response to Origin pipeline error handling. If the origin receives data records from destinations and error records from the pipeline, then the origin includes only the error records in the response. If the origin receives no data records from destinations and no error records from the pipeline, then the origin generates an empty response.

Sample Responses

The following samples in JSON format show responses with an envelope and raw responses without an envelope when the origin receives single records and multiple records:

Single record

The origin receives a single record from the Send Response to Origin destination. The destination is configured to use the 200 status code.

For a response with an envelope, the origin sends the following response:

{
"httpStatusCode":200,
"data":[{"ID":"103","NAME":"Jack","AGE":"37","STATE":"MD"}],
"error":[],
"errorMessage":null
}

For a raw response, the origin sends the following response:

{"ID":"103","NAME":"Jack","AGE":"37","STATE":"MD"}

Multiple data and error records

The origin receives several records, data and error. Because each record has a different status code, the response uses status code 207 for multiple statuses. The errorMessage key includes the error associated with the first record which has a missing ID. The origin is configured to present multiple records as multiple JSON objects.

For a response with an envelope, the origin sends the following response:

{
"httpStatusCode":207,
"data":[{"ID":"248","NAME":"Pina","AGE":"24","STATE":"RI"}],
"error":[{"NAME":"Liz","AGE":"37","STATE":"DE"}, {"ID":"302","NAME":"Roco","AGE":"","STATE":"CA"}],
"errorMessage":"COMMON_0001 - Stage precondition: CONTAINER_0051 - Unsatisfied precondition(s) '${record:exists('/ID')}'"
}

For a raw response, the origin sends the following response:

{"NAME":"Liz","AGE":"37","STATE":"DE"}, {"ID":"302","NAME":"Roco","AGE":"","STATE":"CA"}

Data Formats

The WebSocket Server origin processes data differently based on the data format that you select.

The WebSocket Server origin processes data formats as follows:

Binary

Generates a record with a single byte array field at the root of the record.

When the data exceeds the user-defined maximum data size, the origin cannot process the data. Because the record is not created, the origin cannot pass the record to the pipeline to be written as an error record. Instead, the origin generates a stage error.

Datagram

Generates a record for every message. The origin can process collectd messages, NetFlow 5 and NetFlow 9 messages, and the following types of syslog messages:

RFC 5424
RFC 3164
Non-standard common messages, such as RFC 3339 dates with no version digit

When processing NetFlow messages, the stage generates different records based on the NetFlow version. When processing NetFlow 9, the records are generated based on the NetFlow 9 configuration properties. For more information, see NetFlow Data Processing.

Delimited

Generates a record for each delimited line.

The CSV parser that you choose determines the delimiter properties that you configure and how the stage handles parsing errors. You can specify if the data includes a header line and whether to use it. You can define the number of lines to skip before reading, the character set of the data, and the root field type to use for the generated record.

You can also configure the stage to replace a string constant with null values and to ignore control characters.

For more information about reading delimited data, see Reading Delimited Data.

JSON

Generates a record for each JSON object. You can process JSON files that include multiple JSON objects or a single JSON array.

When an object exceeds the maximum object length defined for the origin, the origin processes the object based on the error handling configured for the stage.

Log

Generates a record for every log line.

When a line exceeds the user-defined maximum line length, the origin truncates longer lines.

You can include the processed log line as a field in the record. If the log line is truncated, and you request the log line in the record, the origin includes the truncated line.

You can define the log format or type to be read.

Protobuf

Generates a record for every protobuf message. By default, the origin assumes messages contain multiple protobuf messages.

Protobuf messages must match the specified message type and be described in the descriptor file.

When the data for a record exceeds 1 MB, the origin cannot continue processing data in the message. The origin handles the message based on the stage error handling property and continues reading the next message.

For information about generating the descriptor file, see Protobuf Data Format Prerequisites.

SDC Record

Generates a record for every record. Use to process records generated by a Data Collector pipeline using the SDC Record data format.

For error records, the origin provides the original record as read from the origin in the original pipeline, as well as error information that you can use to correct the record.

When processing error records, the origin expects the error file names and contents as generated by the original pipeline.

Text

Generates a record for each line of text or for each section of text based on a custom delimiter.

When a line or section exceeds the maximum line length defined for the origin, the origin truncates it. The origin adds a boolean field named Truncated to indicate if the line was truncated.

For more information about processing text with a custom delimiter, see Text Data Format with Custom Delimiters.

XML

Generates records based on a user-defined delimiter element. Use an XML element directly under the root element or define a simplified XPath expression. If you do not define a delimiter element, the origin treats the XML file as a single record.

Generated records include XML attributes and namespace declarations as fields in the record by default. You can configure the stage to include them in the record as field attributes.

You can include XPath information for each parsed XML element and XML attribute in field attributes. This also places each namespace in an xmlns record header attribute.

When a record exceeds the user-defined maximum record length, the origin skips the record and continues processing with the next record. It sends the skipped record to the pipeline for error handling.

Use the XML data format to process valid XML documents. For more information about XML processing, see Reading and Processing XML Data.

Tip: If you want to process invalid XML documents, you can try using the text data format with custom delimiters. For more information, see Processing XML Data with Custom Delimiters.

Configuring a WebSocket Server Origin

Configure a WebSocket Server origin to generate multiple threads for parallel processing of WebSocket client requests.

In the Properties panel, on the General tab, configure the following properties:

General Property	Description
Name	Stage name.
Description	Optional description.
On Record Error	Error record handling for the stage: Discard - Discards the record. Send to Error - Sends the record to the pipeline for error handling. Stop Pipeline - Stops the pipeline.

On the WebSocket tab, configure the following properties:

WebSocket Property	Description
WebSocket Listening Port	Listening port for the WebSocket Server origin. The port number must be included in the URL that the WebSocket client uses to pass data. Note: No other pipelines or processes can already be bound to the listening port. The listening port can be used only by a single pipeline. For more information, see Prerequisites.
Application ID	Application ID used to pass requests to the WebSocket Server origin. The application ID must be included in the header of the WebSocket request or in a query parameter of the URL that the WebSocket client uses to pass data. For more information, see Prerequisites.
Application ID in URL	Enables reading the application ID from the URL. Use when WebSocket clients include the application ID in the URL query parameter instead of in the request header. For more information, see Prerequisites.
Max Concurrent Requests	Maximum number of WebSocket clients allowed to send messages to the origin at one time. If the origin reaches the configured maximum and receives additional requests from different clients, it processes those requests as slots become available. This property also determines how many threads the origin generates and uses for multithreaded processing. For more information, see Multithreaded Processing.
Max Request Size (MB)	Maximum size of the request body that the origin can process.
Idle Timeout (ms)	Maximum time in milliseconds to allow a WebSocket client connection to the WebSocket Server origin to remain idle. After no messages are sent to the origin for this amount of time, the connection is closed. The WebSocket client must reconnect to the WebSocket Server origin. Default is 20,000 milliseconds.

To use SSL/TLS, click the TLS tab and configure the following properties:

TLS Property	Description
Use TLS	Enables the use of TLS.
Use Remote Keystore	Enables loading the contents of the keystore from a remote credential store or from values entered in the stage properties. For more information, see Remote Keystore and Truststore.
Private Key	Private key used in the remote keystore. Enter a credential function that returns the key or enter the contents of the key.
Certificate Chain	Each PEM certificate used in the remote keystore. Enter a credential function that returns the certificate or enter the contents of the certificate.
Keystore File	Path to the local keystore file. Enter an absolute path to the file or enter the following expression to define the file stored in the Data Collector resources directory: `${runtime:resourcesDirPath()}/keystore.jks` By default, no keystore is used.
Keystore Type	Type of keystore to use. Use one of the following types: Java Keystore File (JKS) PKCS #12 (p12 file) Default is Java Keystore File (JKS).
Keystore Password	Password to the keystore file. A password is optional, but recommended. Tip: To secure sensitive information such as passwords, you can use runtime resources or credential stores.
Keystore Key Algorithm	Algorithm to manage the keystore. Default is SunX509.
Use Default Protocols	Uses the default TLSv1.2 transport layer security (TLS) protocol. To use a different protocol, clear this option.
Transport Protocols	TLS protocols to use. To use a protocol other than the default TLSv1.2, click the Add icon and enter the protocol name. You can use simple or bulk edit mode to add protocols. Note: Older protocols are not as secure as TLSv1.2.
Use Default Cipher Suites	Uses a default cipher suite for the SSL/TLS handshake. To use a different cipher suite, clear this option.
Cipher Suites	Cipher suites to use. To use a cipher suite that is not a part of the default set, click the Add icon and enter the name of the cipher suite. You can use simple or bulk edit mode to add cipher suites. Enter the Java Secure Socket Extension (JSSE) name for the additional cipher suites that you want to use.

On the Data Format tab, configure the following property:

Data Format Property	Description
Data Format	Type of data to be processed. Use one of the following data formats: Binary Datagram Delimited JSON Log Protobuf SDC Record Text XML

Data Format Property

Description

Data Format

Type of data to be processed.

Use one of the following data formats:

Binary
Datagram
Delimited
JSON
Log
Protobuf
SDC Record
Text
XML

For binary data, on the Data Format tab, configure the following properties:

Binary Property	Description
Compression Format	The compression format of the files: None - Processes only uncompressed files. Compressed File - Processes files compressed by the supported compression formats. Archive - Processes files archived by the supported archive formats. Compressed Archive - Processes files archived and compressed by the supported archive and compression formats.
File Name Pattern within Compressed Directory	For archive and compressed archive files, file name pattern that represents the files to process within the compressed directory. You can use UNIX-style wildcards, such as an asterisk or question mark. For example, .json. Default is , which processes all files.
Max Data Size (bytes)	Maximum number of bytes in the message. Larger messages cannot be processed or written to error.

For datagram data, on the Data Format tab, configure the following properties:

Datagram Properties	Description
Datagram Packet Format	Packet format of the data: collectd NetFlow syslog Raw/separated data
TypesDB File Path	Path to a user-provided types.db file. Overrides the default types.db file. For collectd data only.
Auth File	Path to an optional authentication file. Use an authentication file to accept signed and encrypted data. For collectd data only.
Convert Hi-Res Time & Interval	Converts the collectd high resolution time format interval and timestamp to UNIX time, in milliseconds. For collectd data only.
Exclude Interval	Excludes the interval field from output record. For collectd data only.
Record Generation Mode	Determines the type of values to include in the record. Select one of the following options: Raw Only Interpreted Only Both Raw and Interpreted For NetFlow 9 data only.
Max Templates in Cache	The maximum number of templates to store in the template cache. For more information about templates, see Caching NetFlow 9 Templates. Default is -1 for an unlimited cache size. For NetFlow 9 data only.
Template Cache Timeout (ms)	The maximum number of milliseconds to cache an idle template. Templates unused for more than the specified time are evicted from the cache. For more information about templates, see Caching NetFlow 9 Templates. Default is -1 for caching templates indefinitely. For NetFlow 9 data only.
Charset	Character encoding of the messages to be processed.
Ignore Control Characters	Removes all ASCII control characters except for the tab, line feed, and carriage return characters.

For delimited data, on the Data Format tab, configure the following properties:

Delimited Property	Description
Header Line	Indicates whether a file contains a header line, and whether to use the header line.
Delimiter Format Type	Delimiter format type. Use one of the following options: Default CSV - File that includes comma-separated values. Ignores empty lines in the file. RFC4180 CSV - Comma-separated file that strictly follows RFC4180 guidelines. MS Excel CSV - Microsoft Excel comma-separated file. MySQL CSV - MySQL comma-separated file. Tab-Separated Values - File that includes tab-separated values. PostgreSQL CSV - PostgreSQL comma-separated file. PostgreSQL Text - PostgreSQL text file. Custom - File that uses user-defined delimiter, escape, and quote characters. Multi Character Delimited - File that uses multiple user-defined characters to delimit fields and lines, and single user-defined escape and quote characters. Available when using the Apache Commons parser type.
Multi Character Field Delimiter	Characters that delimit fields. Default is two pipe characters (\|\|). Available when using the Apache Commons parser with the multi-character delimiter format.
Multi Character Line Delimiter	Characters that delimit lines or records. Default is the newline character (\n). Available when using the Apache Commons parser with the multi-character delimiter format.
Delimiter Character	Delimiter character. Select one of the available options or use Other to enter a custom character. You can enter a Unicode control character using the format `\uNNNN`, where N is a hexadecimal digit from the numbers 0-9 or the letters A-F. For example, enter `\u0000` to use the null character as the delimiter or `\u2028` to use a line separator as the delimiter. Default is the pipe character ( \| ). Available when using the Apache Commons parser with a custom delimiter format.
Field Separator	One or more characters to use as delimiter characters between columns. Available when using the Univocity parser.
Escape Character	Escape character. Available when using the Apache Commons parser with the custom or multi-character delimiter format. Also available when using the Univocity parser.
Quote Character	Quote character. Available when using the Apache Commons parser with the custom or multi-character delimiter format. Also available when using the Univocity parser.
Line Separator	Line separator. Available when using the Univocity parser.
Allow Comments	Allows commented data to be ignored for custom delimiter format. Available when using the Univocity parser.
Comment Character	Character that marks a comment when comments are enabled for custom delimiter format. Available when using the Univocity parser.
Enable Comments	Allows commented data to be ignored for custom delimiter format. Available when using the Apache Commons parser.
Comment Marker	Character that marks a comment when comments are enabled for custom delimiter format. Available when using the Apache Commons parser.
Lines to Skip	Number of lines to skip before reading data.
Compression Format	The compression format of the files: None - Processes only uncompressed files. Compressed File - Processes files compressed by the supported compression formats. Archive - Processes files archived by the supported archive formats. Compressed Archive - Processes files archived and compressed by the supported archive and compression formats.
File Name Pattern within Compressed Directory	For archive and compressed archive files, file name pattern that represents the files to process within the compressed directory. You can use UNIX-style wildcards, such as an asterisk or question mark. For example, .json. Default is , which processes all files.
CSV Parser	Parser to use to process delimited data: Apache Commons - Provides robust parsing and a wide range of delimited format types. Univocity - Can provide faster processing for wide delimited files, such as those with over 200 columns. Default is Apache Commons.
Max Columns	Maximum number of columns to process per record. Available when using the Univocity parser.
Max Character per Column	Maximum number of characters to process in each column. Available when using the Univocity parser.
Skip Empty Lines	Allows skipping empty lines. Available when using the Univocity parser.
Allow Extra Columns	Allows processing records with more columns than exist in the header line. Available when using the Apache Commons parser to process data with a header line.
Extra Column Prefix	Prefix to use for any additional columns. Extra columns are named using the prefix and sequential increasing integers as follows: `<prefix><integer>`. For example, `_extra_1`. Default is `_extra_`. Available when using the Apache Commons parser to process data with a header line while allowing extra columns.
Max Record Length (chars)	Maximum length of a record in characters. Longer records are not read. This property can be limited by the Data Collector parser buffer size. For more information, see Maximum Record Size. Available when using the Apache Commons parser.
Ignore Empty Lines	Allows empty lines to be ignored. Available when using the Apache Commons parser with the custom delimiter format.
Root Field Type	Root field type to use: List-Map - Generates an indexed list of data. Enables you to use standard functions to process data. Use for new pipelines. List - Generates a record with an indexed list with a map for header and value. Requires the use of delimited data functions to process data. Use only to maintain pipelines created before 1.1.0.
Parse NULLs	Replaces the specified string constant with null values.
NULL Constant	String constant to replace with null values.
Charset	Character encoding of the files to be processed.
Ignore Control Characters	Removes all ASCII control characters except for the tab, line feed, and carriage return characters.

For JSON data, on the Data Format tab, configure the following properties:

JSON Property	Description
JSON Content	Type of JSON content. Use one of the following options: JSON array of objects Multiple JSON objects
Compression Format	The compression format of the files: None - Processes only uncompressed files. Compressed File - Processes files compressed by the supported compression formats. Archive - Processes files archived by the supported archive formats. Compressed Archive - Processes files archived and compressed by the supported archive and compression formats.
File Name Pattern within Compressed Directory	For archive and compressed archive files, file name pattern that represents the files to process within the compressed directory. You can use UNIX-style wildcards, such as an asterisk or question mark. For example, .json. Default is , which processes all files.
Max Object Length (chars)	Maximum number of characters in a JSON object. Longer objects are diverted to the pipeline for error handling. This property can be limited by the Data Collector parser buffer size. For more information, see Maximum Record Size.
Charset	Character encoding of the files to be processed.
Ignore Control Characters	Removes all ASCII control characters except for the tab, line feed, and carriage return characters.

For log data, on the Data Format tab, configure the following properties:

Log Property	Description
Log Format	Format of the log files. Use one of the following options: Common Log Format Combined Log Format Apache Error Log Format Apache Access Log Custom Format Regular Expression Grok Pattern Log4j Common Event Format (CEF) Log Event Extended Format (LEEF)
Compression Format	The compression format of the files: None - Processes only uncompressed files. Compressed File - Processes files compressed by the supported compression formats. Archive - Processes files archived by the supported archive formats. Compressed Archive - Processes files archived and compressed by the supported archive and compression formats.
File Name Pattern within Compressed Directory	For archive and compressed archive files, file name pattern that represents the files to process within the compressed directory. You can use UNIX-style wildcards, such as an asterisk or question mark. For example, .json. Default is , which processes all files.
Max Line Length	Maximum length of a log line. The origin truncates longer lines. This property can be limited by the Data Collector parser buffer size. For more information, see Maximum Record Size.
Retain Original Line	Determines how to treat the original log line. Select to include the original log line as a field in the resulting record. By default, the original line is discarded.
Charset	Character encoding of the files to be processed.
Ignore Control Characters	Removes all ASCII control characters except for the tab, line feed, and carriage return characters.

When you select Apache Access Log Custom Format, use Apache log format strings to define the Custom Log Format.
When you select Regular Expression, enter the regular expression that describes the log format, and then map the fields that you want to include to each regular expression group.
When you select Grok Pattern, you can use the Grok Pattern Definition field to define custom grok patterns. You can define a pattern on each line.
In the Grok Pattern field, enter the pattern to use to parse the log. You can use a predefined grok patterns or create a custom grok pattern using patterns defined in Grok Pattern Definition.

For more information about defining grok patterns and supported grok patterns, see Defining Grok Patterns.

When you select Log4j, define the following properties:

Log4j Property	Description
On Parse Error	Determines how to handle information that cannot be parsed: Skip and Log Error - Skips reading the line and logs a stage error. Skip, No Error - Skips reading the line and does not log an error. Include as Stack Trace - Includes information that cannot be parsed as a stack trace to the previously-read log line. The information is added to the message field for the last valid log line.
Use Custom Log Format	Allows you to define a custom log format.
Custom Log4J Format	Use log4j variables to define a custom log format.

For protobuf data, on the Data Format tab, configure the following properties:

Protobuf Property	Description
Protobuf Descriptor File	Descriptor file (.desc) to use. The descriptor file must be in the Data Collector resources directory, `$SDC_RESOURCES`. For information about generating the descriptor file, see Protobuf Data Format Prerequisites. For more information about environment variables, see Java and Security Configuration.
Message Type	The fully-qualified name for the message type to use when reading data. Use the following format: `<package name>.<message type>`. Use a message type defined in the descriptor file.
Delimited Messages	Indicates if a message might include more than one protobuf message.
Compression Format	The compression format of the files: None - Processes only uncompressed files. Compressed File - Processes files compressed by the supported compression formats. Archive - Processes files archived by the supported archive formats. Compressed Archive - Processes files archived and compressed by the supported archive and compression formats.
File Name Pattern within Compressed Directory	For archive and compressed archive files, file name pattern that represents the files to process within the compressed directory. You can use UNIX-style wildcards, such as an asterisk or question mark. For example, .json. Default is , which processes all files.

For SDC Record data, on the Data Format tab, configure the following properties:

SDC Record Property	Description
Compression Format	The compression format of the files: None - Processes only uncompressed files. Compressed File - Processes files compressed by the supported compression formats. Archive - Processes files archived by the supported archive formats. Compressed Archive - Processes files archived and compressed by the supported archive and compression formats.
File Name Pattern within Compressed Directory	For archive and compressed archive files, file name pattern that represents the files to process within the compressed directory. You can use UNIX-style wildcards, such as an asterisk or question mark. For example, .json. Default is , which processes all files.

For text data, on the Data Format tab, configure the following properties:

Text Property	Description
Max Line Length	Maximum number of characters allowed for a line. Longer lines are truncated. Adds a boolean field to the record to indicate if it was truncated. The field name is Truncated. This property can be limited by the Data Collector parser buffer size. For more information, see Maximum Record Size.
Use Custom Delimiter	Uses custom delimiters to define records instead of line breaks.
Custom Delimiter	One or more characters to use to define records.
Include Custom Delimiter	Includes delimiter characters in the record.
Charset	Character encoding of the files to be processed.
Ignore Control Characters	Removes all ASCII control characters except for the tab, line feed, and carriage return characters.

For XML data, on the Data Format tab, configure the following properties:

XML Property	Description
Delimiter Element	Delimiter to use to generate records. Omit a delimiter to treat the entire XML document as one record. Use one of the following: An XML element directly under the root element. Use the XML element name without surrounding angle brackets ( < > ) . For example, msg instead of <msg>. A simplified XPath expression that specifies the data to use. Use a simplified XPath expression to access data deeper in the XML document or data that requires a more complex access method. For more information about valid syntax, see Simplified XPath Syntax.
Compression Format	The compression format of the files: None - Processes only uncompressed files. Compressed File - Processes files compressed by the supported compression formats. Archive - Processes files archived by the supported archive formats. Compressed Archive - Processes files archived and compressed by the supported archive and compression formats.
File Name Pattern within Compressed Directory	For archive and compressed archive files, file name pattern that represents the files to process within the compressed directory. You can use UNIX-style wildcards, such as an asterisk or question mark. For example, .json. Default is , which processes all files.
Preserve Root Element	Includes the root element in the generated records. When omitting a delimiter to generate a single record, the root element is the root element of the XML document. When specifying a delimiter to generate multiple records, the root element is the XML element specified as the delimiter element or is the last XML element in the simplified XPath expression specified as the delimiter element.
Include Field XPaths	Includes the XPath to each parsed XML element and XML attribute in field attributes. Also includes each namespace in an xmlns record header attribute. When not selected, this information is not included in the record. By default, the property is not selected.
Namespaces	Namespace prefix and URI to use when parsing the XML document. Define namespaces when the XML element being used includes a namespace prefix or when the XPath expression includes namespaces. For information about using namespaces with an XML element, see Using XML Elements with Namespaces. For information about using namespaces with XPath expressions, see Using XPath Expressions with Namespaces. Using simple or bulk edit mode, click the Add icon to add additional namespaces.
Output Field Attributes	Includes XML attributes and namespace declarations in the record as field attributes. When not selected, XML attributes and namespace declarations are included in the record as fields. By default, the property is not selected.
Max Record Length (chars)	The maximum number of characters in a record. Longer records are diverted to the pipeline for error handling. This property can be limited by the Data Collector parser buffer size. For more information, see Maximum Record Size.
Charset	Character encoding of the files to be processed.
Ignore Control Characters	Removes all ASCII control characters except for the tab, line feed, and carriage return characters.

When using the origin in a microservice pipeline, on the WebSocket Response tab, configure the following properties. In non-microservice pipelines, these properties are ignored.

WebSocket Response Property	Description
Send Raw Response	Enables the origin to send a response without an envelope.
Data Format	Data format of the payload. Select one of the following options: JSON XML
JSON Content	Method used to present multiple records in a JSON response: JSON array of objects Multiple JSON objects Available for the JSON data format.
Charset	Character set of the request body in a JSON response. Available for the JSON data format.
Pretty Format	Enables the origin to write XML responses with human readable indentation. Available for the XML data format.
Validate Schema	Enables the origin to validate XML responses against the provided schema. Available for the XML data format.
XML Schema	Schema that the origin uses to validate XML responses. Available when validating schemas for the XML data format.