Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
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.
Links
You can use SPLDOC to mark up different kinds of links.
URI links
The URI is enclosed by square brackets: [<URI>]. You can add a label for the link by specifying the label text after the URI: [<URI>|<label>].

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.
- 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.
  - Quick reference for SPLDOC markup
    SPLDOC markup tags document SPL artifacts in a toolkit.
  - Comments
    This information describes the comment syntax for the SPL artifacts in SPL files. SPLDOC comments are delimited by the forward slash and asterisk characters.
  - Text markup
    You can use SPLDOC markup to format text into pages, sections, paragraphs, lists, and blocks of code. You can also apply different typefaces, such as italics, bold, and monospace.
  - Escape
    To suppress interpretation by the spl-make-doc command, precede the SPLDOC markup character by a backslash ( \ ), which is the escape character.
  - Links
    You can use SPLDOC to mark up different kinds of links.
    - URI links
      The URI is enclosed by square brackets: [<URI>]. You can add a label for the link by specifying the label text after the URI: [<URI>|<label>].
    - Links to SPL artifacts
      In a toolkit, you can use SPLDOC to mark up links to toolkits, namespaces, operators, functions, types, and SPL files. The name of the artifact is enclosed in square brackets: [LinuxPipe].
    - Links to functions
      To link to a function, you must qualify the function name in the link definition by the parameter types that are input by the function.
  - Annotation tags
    You can use the SPLDOC annotation tags to document the interfaces that are exposed by the SPL composite operators and to exclude toolkit artifacts. You can also use SPLDOC annotation tags to document SPL and native functions.
  - Images
    You can embed image files in the generated document by specifying the image file name and a label for the image.
  - Formatting conventions
    By following the formatting conventions when you mark up the toolkit artifacts, you ensure that the spl-make-doc command interprets the markup correctly and generates the expected results.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

URI links

The URI is enclosed by square brackets: [<URI>]. You can add a label for the link by specifying the label text after the URI: [<URI>|<label>].

URI links

The following example generates a link to the Teracloud® main web page.

[http://www.teracloud.com]

The spl-make-doc command generates HTML similar to this code.

<a href="http://www.teracloud.com">http://www.teracloud.com</a>

Note: An SPLDOC link to an external resource such as a website, must include a URI scheme name. Typically, the scheme names are http and https. For example, [http://www.ibm.com] creates a link to the Teracloud® website. However, [www.ibm.com] results in an incorrectly formed link and an error.

In addition to generating absolute links to HTML pages, you can generate relative links. The following example adds a link to the top-level Javadoc™ page that was generated in the doc/javadoc/html directory of the toolkit:

[../../javadoc/html/index.html]

The spl-make-doc command generates HTML similar to this code.

<a href="../../javadoc/html/index.html">../../javadoc/html/index.html</a>

This link is relative to the location of the SPLDOC documentation. For this example, the SPLDOC was generated in the doc/spldoc/html default directory location in the toolkit.

URI links with a label

The following example creates a link to the Teracloud® main web page that is accessed through the "Teracloud® main web page" label.

[http://www.ibm.com|IBM main web page]

The spl-make-doc command generates HTML similar to this code.

<a href="http://www.ibm.com">IBM main web page</a>