Download This Plugin

vCommander Build

Plugin Version

Beta
https://github.com/Embotics/Plugins/raw/master/Build_1006040278/snapshot.zip


Adding Workflow Plug-In Steps

Embotics provides preconfigured workflow steps for common DevOps scenarios from the publicly-accessible Embotics Git Repository. You can download packages of grouped workflow plug-in steps, as required, and add them to a vCommander instance (version 7.0.0 or greater).

Using these workflow plug-in steps can save you development time when compared to creating custom workflow steps in house. It is also allows you to download workflow steps that are specifically suited to your development needs, only when you need them. You can use workflow plug-in steps in a workflow as long as the workflow types and target types match.

Workflow plug-in steps are provided in individual JAR (Java ARchive) packages that will contain one or more workflow steps that are defined as YAML files. Each step can be used independently in a workflow. If there are multiple steps in a jar file, they are only packaged together as a convenience because they are related to common tasks.

When you are creating or editing a workflow, any workflow plug-in steps that have been added to your system will appear as available steps in the Worfkflow configuration dialogs.

To add workflow plug-in steps to your system:

  1. Go to the Embotics Git Repository (https://github.com/Embotics/Workflows) and download a package that contains workflow plug-in steps that you want to use in vCommander.

    By default, the .jar package file will be saved to your local Downloads directory. However, depending on your browser, you may be able to change the directory it's downloaded to.

  2. Ensure that the vCommander service is not running.

    For information on how to start, stop and restart the vCommander service, see Managing vCommander Services with the Control Panel.

  3. To add workflow plug-in steps to your vCommander installation, copy the downloaded .jar file to the wfplugins directory of your vCommander installation (<vCommander_install_directory>\tomcat\wfplugins\).
  4. Restart the vCommander service, then log in to vCommander.

    Now when you are creating or editing a workflow, any added workflow plug-in steps will appear as available steps in the Worfkflow configuration dialog.

    Pluggable Workflow Steps

Removing workflow plug-in steps

To remove workflow plug-in steps from a vCommander installation:

  1. Ensure that the vCommander service is not running.

    For information on how to start, stop and restart the vCommander service, see Managing vCommander Services with the Control Panel.

  2. Remove the .jar file that contains the steps you no longer want to appear in the Workflow configuration dialogs step from the wfplugins directory of your vCommander installation (<vCommander_install_directory>\tomcat\wfplugins\) .
  3. Restart the vCommander service, then log in to vCommander.

    The workflow steps included that .jar file will no longer be available in the Worfkflow configuration dialogs.

Updating workflow plug-in steps

If there are updates to a group of workflow plug-in steps that you have installed, and you want to use the latest version, you can remove the existing .jar that contains those steps from the wfplugins directory when vCommander is not running, and add the updated .jar to the same directory in its place. When the system is restarted, the updated workflow steps will be available in the Worfkflow configuration dialog.

To update workflow plug-in steps:

  1. Go to the Embotics Git Repository (http://git.embotics.com/vCommander/workflows) and download the updated .jar package file.

    By default, the .jar file will be saved to your local Downloads directory. However, depending on your browser, you may be able to change the directory it's downloaded to.

  2. Ensure that the vCommander service is not running.

    For information on how to start, stop, and restart the vCommander service, see Managing vCommander Services with the Control Panel.

  3. Remove the .jar file that you want to replace from the wfplugins directory of your vCommander installation (<vCommander_install_directory>\tomcat\wfplugins\).
  4. Copy the updated .jar file that you downloaded to the same wfplugins.
  5. Restart the vCommander service, then log in to vCommander.

    Now when you are creating or editing a workflow, the updated workflow plug-in steps will appear as available steps in the Workflow configuration dialogs.