IBM Streams 4.3.0

Toolkit naming conventions

Toolkits are a set of Streams Processing Language (SPL) artifacts that are organized into a package. Toolkit names typically include a distinctive characteristic or common theme for all operators included in the toolkit.

When you name toolkits, include the info.xml file. This file contains basic information about the toolkit, such as its name, version, and dependencies, and improves the usability of the toolkit in the Streams Explorer view of the Streams Studio.

Follow these naming conventions for toolkit names:

Use a dot-separated sequence of characters, for example, com.ibm.streams.db.
Use lowercase letters.
Precede the name of the toolkit with the reverse domain name used by the organization that authors it, for example, com.ibm.streams.db. This practice helps avoiding name clashes among different toolkits.
Use the toolkit name as the name of the root directory where the toolkit is located.

Consider this toolkit information model that is included as a part of Database Toolkit.

01: <toolkitInfoModel
02:  xmlns="http://www.ibm.com/xmlns/prod/streams/spl/toolkitInfo"
03:  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
04:   xsi:schemaLocation="http://www.ibm.com/xmlns/prod/streams/spl/toolkitInfo 
05: toolkitInfoModel.xsd">
06:   <identity>
07:     <name>com.ibm.streams.db</name>
08:     <description>Database Adapters Toolkit</description>
09:     <version>1.0.0</version>     
10:     <requiredProductVersion>2.0</requiredProductVersion>
11:   </identity>
12:   <dependencies/>
13: </toolkitInfoModel>

The name of the toolkit (specified with the tag <name>) is com.ibm.streams.db (line 7). The prefix com.ibm.streams is common to all toolkits distributed with IBM® Streams, and the name db indicates that all operators in this toolkit are related to accessing databases.