UrbanCode plug-ins provide tools for creating component processes and integrations. IBM UrbanCode provides plug-ins for several common deployment processes, and others are available to integrate with a wide variety of tools, such as middleware tools, databases, and servers.

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

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 can serve various purposes, from providing input to the command to supplying some, or all, the actual command itself. Automation-type plug-in properties can be set at design time in the process editor, 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 deploy components or otherwise manage them. Each step is a self-contained unit with inputs, outputs, and properties. By combining automation plug-in steps in the process editor, you can create fully automated deployment processes. When you create a process, you drag 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. The process flow is defined by drawing connections between steps. The following illustration, shows a series of automation-type plug-in steps and the connections between them.

A simple component process that uses the WebSphere Application Server plug-in to deploy an application

For information about creating component processes, see Component processes.

At deployment time, component 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:

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

Source-type plug-ins#

You use source plug-ins to import artifacts and create component versions. 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 components are created, you do not use the process editor to configure source-type plug-ins. Unlike automation plug-ins, source plug-ins always have a single step, the Import Version step.

Artifacts are imported into component versions by agents that are running in the environment where the artifacts are located. For a component version 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 Server settings.

Viewing and obtaining plug-ins#

Plug-ins that are shipped with the product are called core plug-ins and plug-ins that can be downloaded and installed from the UrbanCode site are called external plug-ins.

View core plug-ins from the user interface as follows:

Plug-ins can be developed and updated more frequently than UrbanCode provided release cycles.

Browse, download, and get documentation for external plug-ins from the UrbanCode site. The site contains many more plug-ins than are packaged with the HCL Launch product.

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

For information about installing plug-ins, see Installing plug-ins.

Parent topic: Extending product function