Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
Toolkits
A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
Toolkits
Toolkit com.teracloud.streams.teda 4.0.0
Developing applications
Configuring Solutions
Configuring ITE Applications
Data Processing
Using checkpointing for custom logic

Welcome
Learn about the core capabilities of Teracloud® Streams, its architecture, and key concepts.
Installing
Use this information to install, upgrade, and uninstall the Teracloud® Streams product.
Configuring
Create a basic or an enterprise domain which is a single point for configuring and managing common resources, security, and instances.
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Developing
Develop stream applications with the Streams Processing Language (SPL), Java, and Python.
Troubleshooting
Resolve problems with Teracloud® Streams using the troubleshooting tools provided with the product as well as the resources offered by Teracloud Support.
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
- APIs
  Application programming interfaces (APIs) provide functions that simplify applications development.
- Job configuration overlays
  You can specify or change configuration parameters when you use the submitjob or updateoperators operations. The settings control submission constraints, host constraints and locations, and operator status. Parameters are captured and updated in the configuration JSON file. When you change the values in the job configuration overlay file, the changes override any previously set values.
- Commands
  Teracloud® Streams provides a number of commands you use to perform tasks.
- Operator model
  An operator model is an XML document that describes the basic properties of a primitive operator.
- Streams Processing Language (SPL)
  Streams Processing Language (SPL) is a distributed data flow composition language that is used in Teracloud® Streams. SPL has primitive types, program structures, and definitions that are tailored for streaming data.
- Toolkits
  A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
  - Specialized toolkit requirements and restrictions
    Several of the specialized toolkits require RPMs that are not required by the Teracloud® Streams product. There are also toolkit restrictions on some platforms.
  - Toolkits
- SPLDOC markup
  You can use SPLDOC markup in the descriptions associated with the SPL artifacts in a toolkit. The spl-make-doc command generates HTML documentation from the marked up artifacts.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

Using checkpointing for custom logic

If you want to preserve the state of your customizations or the deduplication over a restart of your application, you must enable checkpointing for the custom or deduplication logic or both. You use the appropriate parameters to do so.

About this task

Enable checkpointing function by switching it on using the provided parameters.

Procedure

In the file <PathToYourApplication>/config/config.cfg, find the ite.businessLogic.group.custom.checkpointing parameter description
Enable the checkpointing function for your custom group logic by setting the parameter to on as follows: ite.businessLogic.group.custom.checkpointing=on
In the file <PathToYourApplication>/config/config.cfg, find the ite.businessLogic.group.custom.timeToKeep parameter description
To specify the number of days after which tuples are removed from the stateful custom group, set the parameter to the wanted value, for example: ite.businessLogic.group.custom.timeToKeep=7d
In the file <PathToYourApplication>/config/config.cfg, find the ite.businessLogic.group.deduplication.checkpointing parameter description
Enable the checkpointing function for the deduplication by setting the parameter to on: ite.businessLogic.group.deduplication.checkpointing=on

You find committed checkpoint files at custom/<groupId>/committed/<input-filename>.bin for the custom logic and <groupId>/committed/<input-filename>.chk for deduplication data. Both file types are under the output directory that is specified with the ite.checkpointing.directory.

CAUTION: If the checkpointing for the group logic is enabled, the ITE application regularly runs internal maintenance tasks that pause the file processing for a few seconds up to several minutes.