Plugins overview

When creating component or global processes, use plugins to configure and run steps for your deployment, such as requests to application servers, build management tools, database and file management systems, and test automation tools.

For details on how to install plugins, see Load and upgrade plugins.

About plugins

Deployment Automation plugins provide tools for creating component and global processes.

Plugins integrate many third-party tools into Deployment Automation, such as application servers and software configuration management products.

Plugins consist of configurable steps which can be thought of as distinct pieces of automation that enable you to create fully automated deployment processes. For example, the Tomcat and WebSphere plugins provide steps that start and stop those servers, install and uninstall applications, and perform other tool-specific tasks.

Each plugin step consists of:

Properties A set of properties serve many purposes, from providing information for the step's command to supplying some or all of the actual command.

When defining properties, you can also create hints. A hint enables you to add a comment to a step when you need to provide more details for other users. To view the comment, point to the step in the design space.
Command A command performs the function associated with the step.
Post-processing script A post-processing script helps ensure that expected results occur. After each step finishes processing, the system runs the step's default post-processing script. You can create and use your own scripts. For details, see Post-processing scripts.

When you create a process, you drag steps onto the design space in the process designer, define their properties, and connect steps in a sequence. For details, see Create and design component processes.

You can set property values when designing a process or at runtime.

Back to top

Plugins at runtime

Component processes are run by agents installed in the target environment. For a process to run successfully, the agent must have access to all resources, tools, and files required by the plugin steps used in the process.

When installing an agent, ensure the following:

  • The agent running the process has the necessary user permissions to execute commands and access any required resources. This 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.
  • Any external tools required by plugin steps are installed in the target environment.
  • The required minimum version of any external tool is installed.

Back to top

Get help for plugins

As you use plugins in processes, point to property fields or the details icon next to the fields to see a short description of each property.

If you require documentation for a plugin beyond that provided in the plugin itself and in the Deployment Automation documentation, check the Community website and the Knowledge Base.

For additional help, follow your usual Support procedures.

Note: The plugin steps often require pre-existing conditions, such as accounts, licenses, security, and login credentials. Consult the integrating products' documentation for information on how to configure and use the integrating software.

Back to top

See also: