Description

HCL Launch is engineered to handle the most complex deployment situations with push-button automation and controlled auditing needed in production. HCL Launch automates application deployments across varying IT environments.

The Launch Plugin for Accelerate imports deployment data from HCL Launch into HCL Accelerate. Applications in HCL Launch can be mapped in the Accelerate pipeline and the application versions can be tracked from the pipeline.

Quick Info

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

1.0.15

ucv-ext-launch:1.0.15.tar

1.0.18

ucv-ext-launch:1.0.18.tar

1.0.22

ucv-ext-launch:1.0.22.tar

1.0.26

ucv-ext-launch:1.0.26.tar

1.0.3

ucv-ext-launch:1.0.3.tar

2.0.2

ucv-ext-launch:2.0.2.tar

2.0.5

ucv-ext-launch:2.0.5.tar

2.0.6

ucv-ext-launch:2.0.6.tar

2.0.8

ucv-ext-launch:2.0.8.tar

ucv-ext-launch:1.0.15.tar

1.0.15


ucv-ext-launch:1.0.18.tar

1.0.18


ucv-ext-launch:1.0.22.tar

1.0.22


ucv-ext-launch:1.0.26.tar

1.0.26


ucv-ext-launch:1.0.3.tar

1.0.3


ucv-ext-launch:2.0.2.tar

2.0.2


ucv-ext-launch:2.0.5.tar

2.0.5


ucv-ext-launch:2.0.6.tar

2.0.6


ucv-ext-launch:2.0.8.tar

2.0.8


Summary

The HCL Launch plugin for HCL Accelerate synchronizes applications, processes, components, versions, snapshots, teams, environments, and more from HCL Launch. A Launch application can be configured as an application in an HCL Accelerate pipeline and the HCL Launch processes can be configured in the HCL Accelerate pipeline. The HCL Accelerate Pipeline can then display the latest version of the application deployed to different environments.

Compatibility

The HCL Launch plug-in requires HCL Accelerate version 2.3 or later.

History

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

Plugin history details
Version Description
2.0.8 ReSync support added. Applies to HCL Accelerate version 2.4.4 or later
2.0.2 This version contains breaking changes to the plugin. Application Process Requests / Deployments initiated from HCL Accelerate are polled by the plugin and then Application Process Status / Deployment Status in HCL Launch is updated in HCL Accelerate. UCV Access Key support is also added in this version, hence the plugin configuration has to be updated to pass a value for ‘User Access Key’ field
1.0.26 Minor enhancements
1.0.22 Minor enhancements
1.0.18 Minor enhancements
1.0.15 Minor enhancements
1.0.3 Minor enhancements

Usage

To use the HCL Launch 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 HCL Launch plugin supports scheduled events integration which are listed in the following table.

Scheduled events
Name Description
syncLaunchEvent Timed event that synchronizes with HCL Launch

Integration

There are two methods to integrate the plug-in:

  • Using the user interface
  • Using a JSON file

The tables in the Configuration properties topic describe the properties used to define the integration.

Using the user interface

  1. From the Plugins page, click Settings > Integrations > Plugins.
  2. Under the Action column for the plug-in, 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. Within the JSON file is a section for integrations. It is in this section that plug-in properties can be defined.

  1. From a value stream page, 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 plug-in 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.

Minimum permission to integrate with HCL Launch

The access token generated from HCL Launch must have the following permissions to connect with HCL Launch.

  • VIEW_APPLICATIONS
  • EDIT_APPLICATIONS
  • VIEW_ENVIRONMENTS
  • EXECUTE_ENVIRONMENTS
  • MANAGE_SECURITY
  • SETTINGS_TAB

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 plug-in integrations.
  • The HCL Launch Configuration Properties table describes the configuration properties that define the connection and communications with the HCL Launch server. When using the JSON method to integrate the plug-in 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 Show Hidden Properties field.

General Configuration properties
Name Description Required Property Name
NA The version of the plug-in 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 integration. 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 Launch server. Enclose the properties within braces. Yes properties
The name of the tenant. Yes tenant_id
NA Unique identifier assigned to the plug-in. The value for the HCL Launch plugin is ucv-ext-launch. Yes type
HCL Launch Configuration Properties
Name Type Description Required Property Name
Access Token String Token to authenticate against HCL Launch. Yes launchToken
Max Launch deployment history days String Number of days to go back and retrieve deployment history on initial sync. No launchMaxDeploymentHistory
Launch team page size String Number of teams to read from HCL per request. No launchTeamsPagination
Url String HCL Launch server url. Yes baseUrl
User Access Key String The user access key to authenticate with this server. Yes ucvAccessKey

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-launch",
      "tenant_id": "tenantid",
      "name": "Launch_Plugin ",
      "properties": {
        "Url": "launch_server_url",
        "ucvAccessKey": "ucv_access_key",
        "launchToken": "launch_access_token"
      }
    }  ]