Installing the plugin

Jenkins uses plugins to control a step in a workflow. A plugin is a script that can be inserted anywhere into a workflow. While a user may retrieve a plugin from the Jenkins registry, OpenRefactory provides the plugin in the distribution package to make it simple for customers to integrate iCR into a Jenkins workflow.

It is likely that the platform running the Jenkins infrastructure is separate from the platform executing iCR. Therefore, it is expected that the person installing iCR will copy the provided plugin onto the server running the Jenkins framework. It should be placed in the appropriate directory used by Jenkins so it can discover and use the plugin. The default directory for this is typically /var/lib/jenkins/plugins.

Once placed in the plugins directory, it is available for use by the designer of the workflow.

NOTE: Once the plugin has been copied to the proper directory, Jenkins must be restarted in order for the plugin to be recognized by Jenkins.

In the example below, the workflow creator is in the Build step phase. By clicking on Add build step a pull-down menu of options appears. Because the icrPlugin.hpi file was added to the Jenkins plugin directory, iCR for Java appears as one of the Build step options.

Selecting it will insert it into the workflow.