Home
Extending Product Function
Learn how to extend the function of HCL DevOps Deploy (Deploy).
Plug-ins
The HCL plug-ins provide tools for creating component processes and integrations. HCL plug-ins 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.
Creating plug-ins
You can create your own plug-ins for use with HCL DevOps Deploy (Deploy). A plug-in consists of XML files and supporting script files that the plug-in requires.
The plugin.xml file for automation plug-ins
An automation plug-in is defined with the plugin.xml file.
The plugin-javaopts.conf file
The plugin-javaopts.conf file can be used to set the JAVA_OPTS environment variable for automation plug-ins that use Groovy.

Extending Product Function
Learn how to extend the function of HCL DevOps Deploy (Deploy).
- Plug-ins
  The HCL plug-ins provide tools for creating component processes and integrations. HCL plug-ins 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.
  - Creating plug-ins
    You can create your own plug-ins for use with HCL DevOps Deploy (Deploy). A plug-in consists of XML files and supporting script files that the plug-in requires.
    - The plugin.xml file for automation plug-ins
      An automation plug-in is defined with the plugin.xml file.
      - The header element
        The mandatory header element identifies the plug-in and contains three mandatory child elements and one optional child element:
      - The plugin-javaopts.conf file
        The plugin-javaopts.conf file can be used to set the JAVA_OPTS environment variable for automation plug-ins that use Groovy.
    - Creating source plug-ins
      Source-type plug-ins are defined the same way that automation-type plug-ins are defined except for some modifications to the plugin.xml file.
    - Plug-in steps: The step-type element
      You define plug-in steps with the step-type element; each step-type element represents a single step in the HCL DevOps Deploy (Deploy) process editor.
    - The command element
      Steps are run by starting the scripting tool or interpreter that is specified by the <command> element. The <command> element's program attribute defines the location of the tool that runs the command.
    - The post-processing element
      When a plug-in step's <command> element finishes processing, the step's mandatory <post-processing> element runs.
    - Upgrading plug-ins
      This example shows how to upgrade a plug-in.
    - The info.xml file
      Use the info.xml file is required for each plug-in. It describes the plug-in and provides release notes to users for each version.
    - Automatically importing objects from plug-ins
      You can add objects to plug-ins so that they are automatically imported when the plug-in is installed or upgraded. Objects include applications, components, component templates, and processes. For example, you can add a component template that implements a standard process to a plug-in, so that the plug-in user does not have to create the component template.
  - Example plug-in
    A plug-in consists of one or more steps. A step represents a unit of functionality that can be user-configured and combined with other steps into a process. Creating a plug-in consists in defining its individual steps and then grouping them together for presentation in HCL DevOps Deploy (Deploy).
- Creating notification templates
  Notification templates are the basis for emails that the server sends to users after an event occurs on the server. You can create customized notification templates by modifying the default templates provided, or by creating new templates of your own.
- REST API reference
  You can use these REST interfaces to automate tasks.
- Command-line client (CLI) reference
  CLI is a command-line interface that provides access to the HCL DevOps Deploy (Deploy) server. It can be used to find or set properties and to run numerous functions.
- Process-as-code feature
  Programmatically manage processes with PAC language.

The plugin-javaopts.conf file

The plugin-javaopts.conf file can be used to set the JAVA_OPTS environment variable for automation plug-ins that use Groovy.

By default, the plugin-javaopts.conf file is stored on the agent computer in the agent_installation_directory/conf/ folder. You can use the plugin-javaopts.conf file to set the JAVA_OPTS environment variable for a plug-in that is different from the JAVA_OPTS variable for the agent process itself. The plug-in must use Groovy, and not Java™.

Note: If there are syntax errors in the plugin-javaopts.conf file, errors and unpredictable behavior can result. Also, any custom modifications that you make to the plugin-javaopts.conf file might be overwritten if you upgrade the agent to a newer version.

JVM options for optimizing performance

When you run a plug-in step, the agent automatically adds the appropriate Java optimization options to the plugin-javaopts.conf file, if it's not available. For example, if you use the IBM Java Runtime Environment (JRE), the agent adds the -Xquickstart parameter automatically to the plugin-javaopts.conf file.

If you use Oracle JDK or Open JDK distributions, the agent adds the -XX:TieredStopAtLevel=1 parameter to the plugin-javaopts.conf file to optimize the plug-in step run time.