Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Term or Acronym

Definition

Batch stream

Anchor

batch stream

batchstream
batchstream

A batch stream

A stream processing

is a stream that processes high volumes of data in batch(es) within a specific time

span

period. It

processes

can process large

amount

amounts of records in one transaction

. For example, data file read via

, for example when reading files from an Amazon S3 bucket.

For batch streams,

the 7799838

Flush happens only when a stream is run.

Bounded Stream

Anchor
collector
collector

A bounded stream is a unidirectional

7799838

Stream that processes finite input units

of input

, for example, complete files or a fixed amount of rows in a database.

ui-text-box
Info

Example

:

Collecting .csv files via SFTP and only setting a "committed" checkpoint for a particular input file once it is guaranteed an entire file has been successfully processed.

Collector

Anchor
collection
collection

A

function

collector is a Function that collects data from a

7799838

Source.

Collection

Anchor
client_mode
client_mode

The process of

Cloud Edition

Usage Engine acquiring data from a

7799838

Source.

ui-text-box
Info

Examples

:

  • Collecting .csv files from an S3 bucket by acting as an HTTPS client

  • Collecting RESTful requests by acting as an HTTPS server

Client Mode

Anchor
decode
decode

A

Client mode is a communication mode where

collectors

Collectors initiate outgoing requests.

ui-text-box
Info

Examples

:

Cloud Edition
  • Usage Engine acting as an HTTPS client.

Cloud Edition acting
  • Usage Engine acting as an SFTP client.

Cloud Edition acting
  • Usage Engine acting as a JDBC client.

Custom References

Custom references refer to an optional feature that is used with SAP-related functions. When enabled it allows

users

you to specify one or more typeCode and id values in the relevant usage records. 

Decode

Anchor
decode
decode

DecodeThe

Decoding is the process of parsing input from a

7799838

Source and converting it into

records

Records in a format that can be sent across a

7799838

Route.

Destination

Anchor
destination
destination

An

Destination is an endpoint to which data is sent from a

7799838

Stream.

Encode

Anchor
encode
encode

The

Encoding is the process of formatting a

record

Record into a format that can be understood by a

7799838

Destination.

ui-text-box
Info

Example

:

Creating a JSON string from a

7799838

Record.

Endpoint

Anchor
endpoint
endpoint

An endpoint is an interface used by the service to connect to an

7799838

Asset. An endpoint may function in either

server

Server mode or

client

Client mode.

ui-text-box
Info

Examples

:

  • S3 bucket

  • SFTP server

  • HTTP server

  • HTTP client

  • Database instance

Flush

Anchor
flush
flush

The flush operation forces

to pass

the stored/buffered (aggregated) data to be passed to the next function in the stream.

Forwarder

Anchor
forwarding
forwarding

A forwarder is a Function that sends data to a

given 7799838

given Destination.

Forwarding

Anchor
function
function

The process of sending data to a

7799838

Destination.

ui-text-box
Info

Examples

:

  • Sending JSON records to a billing system via HTTPS

  • Storing .csv files in an S3 bucket

Function

Anchor
record
record

A

Function

function accepts input, applies logic to it, and then returns a result. Functions

may

can be stateful.

ui-text-box
Info

Examples

:Notification Group

  • Filtering fields from records

  • Renaming fields in records

  • Aggregating multiple records.

HTTP Response Headers

This is an option found within the HTTP Client collector and processor function, intended to support the sending out of response headers in the network stream. The users can enter a custom value in the result header key and associated result key to configure the target web service. 

Notification Group

Anchor

Notification Group

Not-group
Not-group

 A notification group is an email list to which automated messages regarding erroneous events related to streams are being sent. The content of the error messages

include

includes stream execution errors, missing files, and related events. 

Payload

Anchor
payload
payload

Refers to the current

Payload is the content of the record.

Record

Anchor
route
route

A record is a unit of data that can be processed by a Function or multiple functions and sent across

routes

Routes.

ui-text-box
Info

Examples

:

  • A decoded line in a .csv file.

  • A decoded JSON payload in an HTTP request.

  • A decoded row in a relational database.

  • A decoded Kinesis message.

RegEx (Regular Expression)

The use of regular expressions implies the creation of custom schemes to which various operations can be executed. 

Real-time stream

Anchor

realtime

rt-stream

realtime

rt-stream

Stream processing

A real-time stream processes data in real-time. The data size is unknown, infinite, and continuous.

During

In real-time streams, the data output rate is as fast as the data input rate. When the incoming data is continuous and requires immediate response

then in that case

, real-time streams

are used. For example, data continuously send via

should b used, for example when data is continuously sent via an HTTP collector.

For

In real-time streams, the

7799838

Flush happens after every 60 seconds. 

Route

Anchor
solution
solution

A route is a link between two

functions

Functions, across which data flows.

ui-text-box
Info

Example

:

A

7799838

Function exposing two outgoing

routes

Routes, e.g. 

records

Records that are either successfully processed or erroneous records.

Session

Anchor
agg_session
agg_session

A representation of aggregated records that is stored before being flushed out. 

Solution

Anchor
source
source

A solution is a set of

streams

Streams that together solve a particular customer problem.

ui-text-box
Info

Examples

:

  • Streams required to perform billing mediation for a cloud biller on incoming usage records.

  • Streams required to acquire the product catalog data for a cloud biller.

Source

An 7799838

A source is an Endpoint from which data is collected into a

7799838

Stream using a given protocol and data format.

Stream

Anchor
stream
stream

A

graph

stream is a graphical representation of data flowing from a

7799838

Source, through a series of

functions

Functions, to a

7799838

Destination.

 

ui-text-box
Info

Example

:

A

 A stream collecting

CSV

.csv files from an Amazon S3 source and forwarding them to a destination database using JDBC.

Time To

Leave

Live (TTL) 

This

Time to Live is a mechanism that limits the lifespan of data in an environment. It is used in functions like

aggregation

Aggregation to express the date and time

where

when a record expires. 

Timeout

Anchor
timeout
timeout

A

Timeout is a method that allows you to set a timer

to

for the execution of a certain function. Timeouts

allow for

enable more efficient usage of limited resources. The

basic

idea is that in

situations where

when a system must wait for something to happen, rather than waiting indefinitely, the waiting will be aborted after the timeout period has elapsed.

Transaction

A transaction is a unit of data that is being processed inside a stream. The definition of a completed transaction is when the stream processes it without any errors. The transactions are by design

are

limited to their specified data sources.

A transaction can refer to a file that is being processed in a stream or a result set from a query. 

The data correction feature

Data Correction also creates transactions

of

for reference

and they are regarded as

which are considered to be separate processes. 

For more information

refer to

, see Transaction Safety.

Transactions Per Second (TPS)

This

Transactions Per Second is a metric showing the number of transactions per second (tps) that can be processed by a given web service. This value can be calculated using this formula:

Tps value for a function =

(

Total number of output events handled by the function

)

/

(duration

Duration of the stream

)