KinesisReceiver

Using the Amazon Kinesis service, receives data records from an Amazon Kinesis stream.

Usage Notes

The performance of this transformer is dependent on the amount of memory allocated to the Java Virtual Machine (JVM). The following environment variables allow you to specify memory available to Java Plugins:

FME_JVM_MIN_HEAP_SIZE: Initial heap size for initializing the JVM. If unset, the default value is 1024K.

These variables must be set in multiples of 1024 and greater than 1 MB. To indicate kilobytes, megabytes, or gigabytes, append k or K, m or M, or g or G respectively. For example, any of these values is acceptable:

6291456

6144k

FME_JVM_MAX_HEAP_SIZE: Maximum heap size for initializing the JVM. If unset, the default value is 16384K.

These variables must be set in multiples of 1024 and greater than 2 MB. To indicate kilobytes, megabytes, or gigabytes, append k or K, m or M, or g or G respectively. For example, any of these values is acceptable:

83886080

81920k

80m

Note To pass additional parameters used by FME to the Java Virtual Machine, use the JAVA_TOOL_OPTIONS environment variable.

Configuration

Input Ports

Output Ports

Output

Features containing data records from the specified Amazon Kinesis stream. The content and other details of the data record are stored as attributes of the feature. The following attributes are used:

Attribute	Description
sequence_number	The sequence number of the data record.
partition_key	The partition key of the data record.
data_blob	The data blob of the data record.
shard_id	The id of the shard which contained the data record.

Parameters

Kinesis Stream

Stream	The name of the Kinesis stream from which data records are to be received.
Region	The AWS region in which the Kinesis stream was created.
Access Key	An access key associated with a user with permission to receive data records from the stream.
Secret Access Key	A secret key paired with the access key provided.

Receive Options

Application Name	The name of the application processing the Kinesis stream.
Idle Time Between Reads	The idle time in seconds between reads from the Kinesis stream. Minimum is 0.001 seconds and can be up to 3 decimal spaces.
Max Records per Read	Maximum number of records that can be received from Kinesis stream per read. Maximum is 10,000 data records.

Stopping Condition

Stopping Condition	If None, the receiver runs indefinitely. If Max Polling Time, enter a maximum polling time in seconds in Max Polling Time. If Max Records Output, enter a maximum number of data records to be output in Max Records to Output. If Both, enter values for both Max Polling Time and Max Records to Output. Whichever of these two stopping conditions is met first will cause the receiver to stop reading from the stream.
Max Polling Time	The maximum time in seconds spent receiving no data records from the Kinesis stream. The polling time will start once all shards in the stream have been initialized. Once the maximum polling time has been reached, the receiver will stop reading from the stream. Minimum is 1 second and must be integer values.
Max Records to Output	The maximum number of data records to be output by the transformer. Once the maximum number of records has been output, the receiver will stop reading from the stream.

Editing Transformer Parameters

Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click beside the applicable parameter.

How to Set Parameter Values

Defining Values

There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters.

Using the Text Editor

The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.

Text Editor

Using the Arithmetic Editor

The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.

Arithmetic Editor

Conditional Values

Set values depending on one or more test conditions that either pass or fail.

Parameter Condition Definition Dialog

Content

Expressions and strings can include a number of functions, characters, parameters, and more.

When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.

Content Types

String Functions	These functions manipulate and format strings.
Special Characters	A set of control characters is available in the Text Editor.
Math Functions	Math functions are available in both editors.
Date/Time Functions	Date and time functions are available in the Text Editor.
Math Operators	These operators are available in the Arithmetic Editor.
FME Feature Functions	These return primarily feature-specific values.
FME Parameters	FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters	Create your own editable parameters.

Dialog Options - Tables

Table Tools

Transformers with table-style parameters have additional tools for populating and manipulating values.

Row Reordering

Enabled once you have clicked on a row item. Choices include:

Add a row
Remove a row
Move current row up one
Move current row down one
Move current row to top
Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

Cut a row - delete and copy to clipboard
Copy a row to the clipboard
Paste a row from the clipboard

Cut, copy, and paste may be used within a transformer, or between transformers.

Filter

Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output.

Import

Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers.

Reset/Refresh

Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers.

Note: Not all tools are available in all transformers.

For more information, see Transformer Parameter Menu Options.

FME Community

The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.

Search for all results about the KinesisReceiver on the FME Community.