Plug-ins

Build plug-ins provide tools for creating workflows and integrating with external tools.

Plug-ins provide processing and integration functions. There are two types of plug-ins:

Source-type plug-ins integrate with SCM systems.
Automation-type plug-ins integrate with external systems and provide job steps.

Both types of plug-ins consist of distinct processes called steps. Each step consists of a number of properties, a command that runs the step, and post processing instructions. (Post processing typically ensures that expected results occur.) Step properties supply values to the plug-in step. Automation-type plug-in properties can be set at design time or at run time in the user interface. Source-type plug-in properties are typically defined when a component is created.

Automation-type plug-ins

You use automation plug-ins to run build job steps or otherwise manage builds. Each step is a self-contained unit with inputs, outputs, and properties. By combining automation plug-in steps, you can create fully automated build processes. When you create a job, you insert steps onto the design area and define the properties as you go. Property values can be specified when you define the process or at run time.

For information about creating jobs, see Creating jobs.

At build time, processes are run by agents that are installed in the target environment. For a process to run, the agent must have access to all resources, tools, and files that are required by the plug-in steps in the process. When you install an agent, ensure that these conditions are met:

The agent that runs the build process has the necessary user permissions to run commands and can access required resources. Assigning these permissions typically entails granting permissions if an external tool is installed as a different user; installing the agent as a service; or impersonating the appropriate user.
External tools that plug-in steps require are installed in the target environment.
The required minimum version of an external tool is installed.

For information about installing agents, see Installing agents from the command line.

Source-type plug-ins

You use source plug-ins to import build artifacts and create builds. A source plug-in defines the type of artifacts that can be imported and identifies where the artifacts are located. Source-type plug-ins are configured when source items are created, you do not use the process editor to configure source-type plug-ins.

Source artifacts are imported by agents that are running in the environment where the artifacts are located. For source material to be created, the agent must have the required permissions and access to all required resources and files.

For information about installing agents that run source plug-ins, see System requirements.

Viewing and obtaining plug-ins

A number of plug-ins come with the product and many others are available that can be downloaded and installed. For information about installing plug-ins, see Installing plug-ins.

View plug-ins that are installed by using the user interface. To view plug-ins, click System > Plug-ins. The plug-in type is displayed in the Type column.

Plug-ins can be developed and updated more frequently than Build provides release cycles.

Browse, download, and get documentation for plug-ins at the Build plug-ins website. The site contains many more plug-ins than are packaged with the Build product.

The site includes plug-ins that are developed by these sources:

IBM® Corporation: Your Build license entitles you to download and install the plug-ins that are developed by IBM Corporation.
Support is provided through the developerWorks® community and through IBM technical support.
Partners: Plug-ins that are provided by partners can be purchased from the partner website.
Support for each partner plug-in is provided exclusively by the partner who provided the plug-in.
Community: Plug-ins are provided by members of the Build community on Build plug-ins website Build plug-ins website. Search with name of the plug-in to find plug-ins. You can contribute to code in the community or use code posted there to incorporate into your own.
Support is provided exclusively through the community.

For information about creating plug-ins, see Creating plug-ins.