Show TOC

Adapter Parameter DatatypesLocate this document in the navigation structure

Describes the datatypes, enumerated in the $STREAMING_HOME/etc/Adapter.xsd file, that may be used for parameters specified in an adapter's .cnxml file.

Some exceptions for custom external adapters are noted in the datatype descriptions.
Note This table includes all the adapter-related datatypes that are supported by Event Stream Processor. For more information about the specific datatypes that are supported by each adapter, as well as for its datatype mapping descriptions, see the section on that adapter.
Datatype Description
boolean

Value is true or false. The format for values outside of the allowed range for boolean is 0/1/false/true/y/n/on/off/yes/no, which is case-insensitive.
choice

A list of custom values from which a user selects one value.
configFilename

Variable-length character string, with byte values encoded in UTF-8. Maximum string length is platform-dependent, but can be no more than 65535 bytes.
directory

Variable-length character string, with byte values encoded in UTF-8. Maximum string length is platform-dependent, but can be no more than 65535 bytes.
double

A 64-bit numeric floating point with double precision. The range of allowed values is approximately -10308 through +10308. Equivalent to float.
float A 64-bit numeric floating point with double precision. The range of allowed values is approximately -10308 through +10308. Equivalent to double.
filename

Variable-length character string, with byte values encoded in UTF-8. Maximum string length is platform-dependent, but can be no more than 65535 bytes.
int

A signed 32-bit integer value. The range of allowed values is -2147483648 to +2147483647 (-23^1 to 2^31-1). Constant values that fall outside of this range are automatically processed as long datatypes.

To initialize a variable, parameter, or column with the lowest negative value, specify (-2...7) -1 instead to avoid CCL compiler errors. For example, specify (-2147483647) -1 to initialize a variable, parameter, or column with a value of -2147483648.
password

Variable-length character string, with byte values encoded in UTF-8. Maximum string length is platform-dependent, but can be no more than 65535 bytes.

While entering a value for this field, user sees '*' for every character.
permutation

Variable-length character string, with byte values encoded in UTF-8. Maximum string length is platform-dependent, but can be no more than 65535 bytes.

This datatype is not supported for custom external adapters.
query

A string value that Studio creates from the table name.

This datatype is not supported for custom external adapters.
range
An integer value for which user can define lower and upper limits. For example, 
<Parameter id="port" label="KDB Port" descr="IP port of the database listener"
      type="range" rangeLow="0" rangeHigh="65535" default="5001"
      use="required"
    />
runtimeDirectory

Variable-length character string, with byte values encoded in UTF-8. Maximum string length is platform-dependent, but no less than 65535 bytes.

This datatype is not supported for custom external adapters.
runtimeFilename

Runtime file name, if different from discovery time file name.

Variable-length character string, with byte values encoded in UTF-8. Maximum string length is platform-dependent, but no more than 65535 bytes.

This datatype is not supported for custom external adapters.
string

Variable-length character string, with byte values encoded in UTF-8. Maximum string length is platform-dependent, but no more than 65535 bytes.
tables

List of choices returned by the getTables() that are defined in the adapter.
text

A value capable of storing multiline text.

This datatype is not supported for custom external adapters.
uint

Positive integer value. The range of allowed values is 0 to 0xffffffff.