Description

Handlebar is a simple templating language. It can be used to generate HTML or other text formats from a template and input object.

Quick Info

Product
HCL Accelerate
Type
plugin
Compatibility
HCL Accelerate version 2.0 or later
Created by
HCL Software
Website
Version Name Action

0.0.17

ucv-ext-handlebars-reporter:0.0.17.tar

0.0.30

ucv-ext-handlebars-reporter:0.0.30.tar

0.0.38

ucv-ext-handlebars-reporter:0.0.38.tar

0.0.39

ucv-ext-handlebars-reporter:0.0.39.tar

0.0.6

ucv-ext-handlebars-reporter:0.0.6.tar

ucv-ext-handlebars-reporter:0.0.17.tar

0.0.17


ucv-ext-handlebars-reporter:0.0.30.tar

0.0.30


ucv-ext-handlebars-reporter:0.0.38.tar

0.0.38


ucv-ext-handlebars-reporter:0.0.39.tar

0.0.39


ucv-ext-handlebars-reporter:0.0.6.tar

0.0.6


Summary

The Handlebar Reporter plugin takes a Handlebars template and using a context generator to create HCL Accelerate reports. This plugin is required to run reports.

Compatibility

Must be running HCL Accelerate version 2.0 and later to use the plugin.

History

The following table describes the changes made in each plugin version.

Plugin history details
Version Description
0.0.17 Minor enhancements
0.0.6 Minor enhancements

Usage

To use the Handlebar Reporter plugin, the plugin must be loaded and an instance created before you can configure the plugin integration. You define configuration properties in the user interface or in a JSON file.

Integration type

The Handlebar Reporter plugin supports scheduled events integration which are listed in the following table.

Scheduled events
Name Description
handlebarsRunner Generates a report.

Integration

There are two methods to integrate the plugin:

  • Using the user interface
  • Using a JSON file

Using the user interface

  1. From the Plugins page, click Settings > Integrations > Plugins.
  2. Under the Action column for the plugin, click Add Integration.
  3. On the Add Integration page enter values for the fields used to configure the integration and define communication.
  4. Click Save.

Using a JSON file

The JSON file contains the information for creating a value stream and integrating with the Handlebar server. The following table describes the information for the creating an HCL Accelerate value stream map.

  1. Download the value stream map. The value stream map is a JSON file used to define integrations.
  2. Edit the JSON file to include the plugin configuration properties.
  3. Save and upload the JSON file. This replaces the current JSON file with the new content.
  4. View the new integration on the Integrations page.

Configuration Properties

The following tables describe the properties used to configure the integration. Each table contains the field name when using the user interface and the property name when using a JSON file.

  • The General Configuration Properties table describes configuration properties used by all plugin integrations.
  • The Handlebar Reporter Configuration Properties table describes the configuration properties that define the connection and communications with the HCL Accelerate server. When using the JSON method to integrate the plugin these properties are coded within the properties configuration property.

Some properties might not be displayed in the user interface, to see all properties enable the Hidden field.

General Configuration properties
Name Description Required Property Name
NA The version of the plugin that you want to use. To view available versions, click the Version History tab. If a value is not specified, the version named latest is used. No image
Integration Name An assigned name to the value stream. Yes name
Logging Level The level of Log4j messages to display in the log file. Valid values are: all, debug, info, warn, error, fatal, off, and trace. No loggingLevel
NA List of plugin configuration properties used to connect and communicate with the HCL Accelerate server. Enclose the properties within braces. Yes properties
The name of the tenant. Yes tenant_id
NA Unique identifier assigned to the plugin. The value for the Handlebar plugin is ucv-ext-handlebars-reporter. Yes type
Handlebar Reporter Configuration Properties
Name Type Description Required Property Name
UCV User Access Key Secure The user access key used to authenticate with the HCL Accelerate server. Yes ucvKey

JSON code sample

The following sample code can be used as a template to define the integration within the JSON file for a value stream. Copy and paste the template into the JSON file Integration section and make the appropriate changes.


"integrations": [
    {
      "type": "ucv-ext-handlebars-reporter",
      "name": "",
      "tenant_id": "",
      "logginglevel": "info",
      "ucvkey": "key,
      "properties": {
                ],
              }
    }
  ]