Upgrade Custom Plug-in

This topic describes how to update or modify your plug-ins to be compatible with a newer schema.

About this task

You must perform these steps if you are prompted to upgrade your custom plug-ins that currently use an old schema. Plug-in developers can either:
  • write a specification, (OR)
  • use any transformation mechanism to create an EXE, JAR, BAT, or JS file.

Procedure

  1. Migrate your old plug-in/s to the new React JSON schema.
  2. Write a transformation specification for plug-in upgrade using one of the methods described in Supported Transformation File Types.
    Note:
    Naming convention for the transformation file is <PluginName>-<FromVersion>-<ToVersion>-spec.js. For example GETrendCard-3.0.1-3.0.2-spec.js|jar|exe|bat.
  3. Log in to the machine where Operations Hub is installed and download the plug-in you want to upgrade. The plug-in is downloaded as a .zip file.
  4. Add your specification file and the Exempt list (if applicable) to a spec.zip.
    Zip the following into a single file and name it as spec.zip:
    A specification file The specification file should use the naming convention: PluginName-fromVersion-toVersion-spec.js

    For example, if updating from version 1.0 to 2.0, the file should be named: ColoredBadge-0.1.0-0.2.0-spec.js

    An Exempt file (optional) Create a text file using the naming convention PluginName-PluginTransformExemptedList.txt and include any exemption entries related to the plug-in transformation in this file.

    For example, ColoredBadge-PluginTransformExemptedList.txt

  5. Place the spec.zip file in this location folder for the respective plug-in ..\Program Files\GE\Operations Hub\iqp-endapp\public\custom\default\<PluginName>


    Note:
    System plug-ins are updated automatically during the Operations Hub upgrade process. Their respective spec.zip files are placed and implemented as part of this upgrade.
  6. Import the custom plug-in.


Results

When Operations Hub administrator imports applications with old plug-ins, they are successfully upgraded to their latest versions.
  • The transformation engine looks for an incremental path of intermediary transformation that can migrate a plug-in from a specific version to a desired version. For instance, GETrendCard-3.0.1-3.0.2-spec.json GETrendCard-3.0.2-3.0.4-spec.json GETrendCard-3.0.4-3.0.5-spec.json are used consecutively to upgrade plug-ins.
  • If incremental upgrades were not performed between Operations Hub versions, then the plug-in version may not remain subsequent for upgrade. For example, consider:
    • Operations Hub 1.7 has 3.0.1 version of GETrendCard
    • Operation Hub 2.5 has 3.0.5 version of GETrendcard

    The GETrendCard-3.0.1-3.0.5-spec.json file may not be available for upgrading plug-ins. In such cases, plug-in upgrades are not performed in Operations Hub.