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
Building your application
Adding toolkits to an ITE application

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.

Adding toolkits to an ITE application

By default, an ITE application uses only the standard SPL toolkit and the TEDA toolkit. If you need to add additional toolkits to your ITE application, specify the location of those toolkits in the toolkitsList.xml file.

About this task

By default, an ITE application only uses the standard SPL toolkit and the TEDA toolkit. If you need to add another toolkit to your ITE application project, you must specify additional toolkit locations in the toolkitsList.xml file. The Makefile checks whether this file exists. If so, it is added by using the -t option to the sc command. This ensures that the project is built with the same settings from the command line.

Procedure

Specify the location of the additional toolkits in the toolkitsList.xml file.

Example

The following example shows how to add a dependency to the toolkitsList.xml file in the rules toolkit project directory:


<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<toolkitList xmlns="http://www.ibm.com/xmlns/prod/streams/spl/toolkitList"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.ibm.com/xmlns/prod/streams/spl/toolkitList
  toolkitListModel.xsd">
  <toolkit directory="/absolute/path/to/STREAMS_INSTALL/toolkits/com.ibm.streams.rules"/>
</toolkitList>