Show TOC

Socket CSV Input Adapter: Managed Mode PropertiesLocate this document in the navigation structure

Use the Studio to configure the adapter. Edit its properties after you attach it to a project.

This adapter uses SimpleDateFormat formatting codes.

When you attach the adapter to a project using the ATTACH ADAPTER statement (rather than through the visual editor), specify the adapter type: TYPE toolkit_socket_csv_input

Property Label Description
Server

Property ID: host

Type: string

(Required) Server host name.

Port

Property ID: port

Type: int

(Required) Server port. To read from the Ephemeral Port File, set to -1.

Ephemeral Port File

Property ID: epFile

Type: filename

(Advanced) File that will contain the server port number if Port is -1. If sandboxing is enabled, this file must reside in the <sandbox-base-directory>/adapters/<workspace-name> or $STREAMING_HOME/adapters/framework directory or one of their subdirectories. If the file is in a different location, the adapter will not be able to successfully connect to Event Stream Processor.

Has Header

Property ID: csvHasHeader

Type: boolean

(Advanced) Indicates whether the first line of the file contains the description of the CSV fields.

Retry Period (seconds)

Property ID: retryperiod

Type: uint

(Advanced) Period for trying to re-establish an outgoing connection.

Buffer Size

Property ID: inputBufferSize

Type: uint

(Advanced) The buffer size of the socket connection (bytes).

Enable TCP keepalive

Property ID: keepAlive

Type: boolean

(Advanced) Enables TCP keepalive on the socket connection.

Charset Name

Property ID: charsetName

Type: string

(Advanced) Specifies the name of a supported charset.

Column Delimiter

Property ID: csvDelimiter

Type: string

(Required) Specifies the symbol(s) used to separate the columns.

Characters from the ASCII printable character set are supported as delimiters. The default value is a comma ( , ).

Certain control characters can be specified as delimiters using the following escape codes:
  • \t – horizontal tab
  • \\ – backslash character
  • \\0 – NUL or null character
SecondDate Format

Property ID: csvSecondDateFormat

Type: string

(Advanced) Specifies the format for parsing seconddate values.

The default value is yyyy-MM-dd'T'HH:mm:ss.

MsDate Format

Property ID: csvMsDateFormat

Type: string

(Advanced) Specifies the format for parsing msdate values.

The default value is yyyy-MM-dd'T'HH:mm:ss.SSS.

Time Format

Property ID: csvTimeFormat

Type: string

(Advanced) Specifies the format for parsing time values.

The default value is HH:mm:ss.

Has Header

Property ID: csvHasHeader

Type: boolean

(Advanced) Indicates whether the first line of the file contains the description of the CSV fields.

Stream name, opcode expected

Property ID: csvExpectStreamNameOpcode

Type: boolean

(Optional) If set to true, the adapter interprets the first two fields of the incoming CSV line as stream name and opcode. The adapter discards messages with unmatched values.

Match Stream Name

Property ID: csvMatchStreamName

Type: boolean

(Optional) If set to true, the CSV element names are matched against the stream name. The adapter discards messages with unmatched values.

If set to true, csvExpectStreamNameOpcode must also be set to true.

PropertySet

Property ID: propertyset

Type: string

(Advanced) Specifies the name of the property set. Property sets are reusable sets of properties that are stored in the project configuration file. Using these sets allows you to move adapter configuration properties out of the CCL file and into the CCR file. If you specify the same properties in the project configuration file and the ATTACH ADAPTER statement, the values in the property set override the values defined in the ATTACH ADAPTER statement. No default value.

Quoted Values

Property ID: csvQuotedValues

Type: string

(Optional) Determines the parsing of incoming delimiter strings containing quoted values. There are three options:
  • no – no quotation marks enclose the delimiter string. For example, aa,bb is parsed as a two values. Any single or double quotation marks are considered part of the string. "aa,bb", where ( , ) is the delimiter, is parsed as two values: "aa and bb".
  • single – single quotation marks enclose the delimiter string. Delimiters within quoted values are ignored. For example, 'aa,bb' is parsed as a single value of aa,bb. If the string contains single quotation marks, they must be doubled. 'aa","b' is parsed as a single value of aa','bb. If not doubled, they are parsed as two delimiter strings ('aa','bb') leading to incorrect parse results or parse failure.
  • double – double quotation marks enclose the delimiter string. Delimiters within quoted values are ignored. For example, "aa,bb" is parsed as a single value of aa,bb. If the string contains double quotation marks, they must be doubled. "aa"",""b" is parsed as a single value of aa","bb. If not doubled, they are parsed as two delimiter strings ("aa","bb") leading to incorrect parse results or parse failure.