Create an HTML Plug-In Project

HTML plug-ins for the
vSphere Client
have two components. User interface components run in the Web browser and Java service components run on the Tomcat server. The
vSphere Client
SDK provides tools for creating an HTML plug-in project template for each of these components. You can run the plug-in project generation scripts to create an HTML plug-in project template and build a plug-in out of the project.
The
vSphere Client
SDK provides two project generation scripts which you can use depending on the operating system of your development environment. Create the project template by using the scripts provided in the
your_SDK_folder
/html-client-sdk/tools/Plugin generation scripts
directory.
  1. In your development environment, open a command prompt or launch the Terminal application.
  2. Navigate to the
    Plugin generation scripts
    folder.
    On a Windows machine, the generation scripts are located at
    SDK_folder
    \html-client-sdk\tools\Plugin generation scripts
    .
  3. Run the
    create-html-plugin.bat
    or the
    create-html-plugin.sh
    script depending on your OS.
  4. When prompted, enter the plug-in name, the directory on your machine where the project template folder structure will be created, and the plug-in package name.
    If you do not specify a value when prompted, the generation script uses predefined default values.
The script generates two folders,
myplugin-service
and
myplugin-ui
. For more information about the contents of each folder, see Contents of the HTML Plug-In Project Template.
After you generate the HTML plug-in project template, you can build the plug-in package and test whether your plug-in works by deploying the plug-in on the
vSphere Client
. For detailed information, see Building a Plug-In Package from the Project Template and Testing the Generated Plug-Ins.