Skip to Content

Plugins

Overview

Plugins are Jitterbit's deprecated method of extending Harmony's native capabilities. The recommended and supported way to extend the Harmony platform is by using the Harmony Connector SDK.

Deprecation and Support

Jitterbit-provided plugins and the Harmony Plugin SDKs are deprecated as described here:

  • Jitterbit-provided Plugins
    Plugins provided by Jitterbit are deprecated and are supported only with regard to defects in their existing code.

    Jitterbit-provided plugins will not be maintained, improved, or updated based on changes to external applications that they act against.

    Jitterbit does not guarantee that such plugins are tested or validated against the latest builds of the Harmony platform or its applications.

  • Harmony Plugin SDKs
    Creating custom plugins using the Harmony Plugin SDKs is deprecated.

    Existing custom plugins developed using the Plugin SDKs should continue to function; however, the Plugin SDKs themselves will not be maintained, improved, or updated, and the ability to create new plugins using the Plugin SDKs may be removed in the future.

    If you are using a custom plugin, you are responsible for the security of the custom plugin.

The recommended and supported way to extend the Harmony platform is by using the Harmony Connector SDK.

Where Plugins Can Be Used

Certain plugins are available by default on Cloud Agent Groups. Additional plugins and custom plugins you create yourself can be used with Private Agents.

Plugins associated with the Agent Group can be executed on sources or targets in an operation or within scripts using Cloud Studio or Design Studio:

Whether a plugin can be used in any of these places depends on the specific plugin. Some plugins can be executed only within a script. Other plugins cannot be executed within scripts but can be executed only on certain sources or targets. The manifest file for a plugin specifies the plugin's parameters and where a plugin may be used.

Reference

These pages are included in this topic:

  • Plugins Available in Harmony
    The list of plugins currently available in Harmony and whether each plugin is available for Cloud Agent Groups. All plugins are available for use with Private Agents.

  • Documentation for each plugin
    The remaining pages in this section are specific to each plugin, including a description of what the plugin does, documentation on each optional or required variable, and a link to download the plugin package, if available.

These pages are also relevant to this topic:

  • Customizations > Plug-ins
    Plugins are added and managed from the Plug-ins page of the Management Console. This includes the ability to associate Jitterbit-provided plugins with a Private Agent Group for use with Private Agents.

  • Plugins (Cloud Studio)
    Information about using plugins in Cloud Studio.

  • Apply Plug-ins (Design Studio)
    Information about how to tell whether an operation in Design Studio requires a plugin and, if so, whether the plugin is installed.

  • Creating a Custom Plugin
    Though deprecated, you can use the Harmony Plugin SDKs to create and publish your own plugins for use with Private Agents. If you are using a custom plugin, you are responsible for the security of the custom plugin.