Velocity Work Item Form Extension

 Custom Velocity-based forms for Work Items


share this page via facebook share this page via LinkedIn share this page via Twitter share this page via Google+ share this page via email More sharing services

Allows rendering of custom panels with content defined by scripts that combine Velocity, HTML and other scripting technologies...  right on the Work Item form


How to install

  1. Download and unzip the packaged extension.
  2. Move the folder bin/com.polarion.alm.velocityform from the zip file com.polarion.alm.velocityform_<version>.zip into: 
    <Polarion Installation Folder>/polarion/extensions/.
  3. Restart Polarion.


How to use

  1. Create the report using Velocity.
  2. Save the file with the script (i.e. my_script.vm) in folder
    <Polarion Installation Folder>/scripts/.
  3. Go to the Administration - Work Items - Form Configuration.
  4. Add/Edit Form Layout of the Work Item type you want to add the Velocity Form to.
  5. Add a line defining the extension with parameters:
    1. id - always "velocity_form", 
    2. label - choose how the form will be labeled, 
    3. script - provide name of the file with the script that should be processed and rendered.

EXAMPLE: <extension id="velocity_form" label="Test Form" script="my_script.vm"/>


Useful Tips

  • The Velocity Context allows access to the usual objects of the Open API - $trackerService
    • it also allows access to the Rendering API - $transaction
    • it contains reference to the current Work Item it is being used on - $object.
  • To check for access rights and persistence of the Work Item, use:
    • #if(!$object.isUnresolvable() && $object.isPersisted()).
  • To get the Rendering API version of the Work Item, use:
    • #set($wi = $transaction.workItems().getBy().oldApiObject($object)).


Known Limitations

  • Content created using this extension cannot be printed.
  • In Polarion <= 2019 SR2 JavaScript execution is not supported due to the way how the content is injected to the work item form page.
  • Polarion 2019 SR3 brought full support for JavaScript execution in any Work Item Form Extensions.



Vendor Siemens PLM
Published Version 1.0.3 - October 2019
Price Free
Supported by Siemens PLM This extension is supported by Siemens PLM for customers with a current support/maintenance agreement.
Requirements Polarion 2018 GA (3.18.0) and newer
Verified with Polarion 2019 SR2 (3.19.2)

Related Extensions