Managing plugins


Plugins are Ruby on Rails code additions for applying custom functionality to BMC Release Process Management.

In plugins, use the manifest.yml file to define the complete file map for your plugin. Use the routes.rb file only to define the routes for the plugin.

Warning

Plugins use the same database as the BMC Release Process Management application. Contact BMC support to register your plugin and avoid duplications for database entries and file names.

You can access your plugins from the Environment tab.

To integrate your plugin into BMC Release Process Management, use the following guidelines:

To create the directory structure for a plugin

When you create a BMC Release Process Management plugin, follow the directory structure below:

dir_structure.png

 

To add a plugin to the application

  1. Go to <RLM_HOME> and create a new plugins folder.
  2. Extract the plugin files to <RLM_HOME>/plugins.
  3. Stop the BMC Release Process Management Server
  4. In command line,  go to <RLM_HOME>\releases\<Current BRPM version>\RPM\config
  5. Create the necessary configuration for the plugin by running the following code:

    jruby -S rake app:plugins_setup PLUGIN_LOCATION=<Plugin_Home>
  6. Load the plugin code into the application by running the following code:

    jruby -S rake app:plugins_load
  7. Create database entries necessary for your plugin by running the following code:

    jruby -S rake db:migrate
  8. Start the BMC Release Process Management Server.

To remove plugins from the application

  1. Stop the BMC Release Process Management Server
  2. In command line,  go to <RLM_HOME>\releases\<Current BRPM version>\RPM\config
  3. Run the following code:

    jruby -S rake app:plugins_remove
  4. Start the BMC Release Process Management Server.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*