Jump to main content
Welcome to the HCL™ Accelerate version 2.4.x documentation, where you can find information about how to install, maintain, and use HCL Accelerate.
Release information
This document contains information about what's new, bug fixes, known issues, and upgrade notes.
What's new
This release of HCL™ Accelerate includes various bug fixes and enhancements. This release is recommended for all customers. This topic provides a summary of enhancements and bug fixes.
Upgrade notes
Getting started
This document provides an overview of HCL™ Accelerate.
System requirements
This document contains information about hardware and software requirements for HCL™ Accelerate.
High-level overview
Use HCL™ Accelerate to automate your release lifecycle and manage your DevOps value stream.
Key to product editions
HCL™ Accelerate is available in several editions.
Introduction to releases and pipelines
A release represents the delivery of multiple applications through one or more phases of a lifecycle. A typical release includes many deployments to test environments and a small number of highly orchestrated deployments to staging and production. Release managers can define milestones that lead up to the release, as well as a plan to deliver participating applications to each phase of the lifecycle.
Home page
Use the Home page to view pipelines, releases, and reports defined in your environment.
Notices for HCL™ Accelerate
HCL™ Accelerate GDPR statement
General Data Protection Regulation (GDPR) has been adopted by the European Union (EU) and applies from May 25, 2018.
Learn how to complete tasks in HCL™ Accelerate.
Create a value stream
In this tutorial, we integrate Jira work items into a value stream and control value stream data with DevOps query language (DQL) queries.
Linking value stream tools
In this tutorial, you integrate the popular tools Git and Jira into a value stream and link them together.
Implementing custom metrics
In this tutorial, you create a custom metric definition and use it to provide data to HCL™ Accelerate.
The installation roadmap is a description of the high-level steps for installing HCL™ Accelerate.
Migrating Docker Compose to Kubernetes
Migrating Docker Compose to Kubernetes.
A default HCL™ Accelerate administrator ID is included as part of HCL Accelerate. It is used to install and complete initial configuration tasks.
Configuring an email server
Configuring an email server
Calendar settings
Use the Calendar Settings page to manage the appearance of calendar events.
The HCL™ Accelerate security model is organization- and team-based. The organization is the base element; teams belong to organizations. Team members manage releases, events, and deployments. Administrators manage teams and assign users to them.
Managing licenses
Configure your license or apply a trial key.
Managing logs
Control the amount of detail sent to log files.
Managing value streams
A value stream represents the objects and activities that you employ to deliver customer value, from initial concept to final delivered project.
Creating value streams
Create a value stream and then customize it by defining phases and stages that reflect your typical workflow.
Viewing value streams
Viewing value streams using list and card view layouts.
Value stream metrics
Assess project quality, progress, and performance with the HCL™ Accelerate metric data tools.
Navigating value streams
Manage a value stream's displayed data by applying filters and queries.
DevOps query language
Use the DevOps query language to filter the information displayed in your value stream.
Pipelines provide a streamlined method to manage the applications in your development lifecycle. With pipelines, you can auto-generate deployment plans and deploy applications versions to all environments.
Developing data insights
The Insights feature provides DevOps metrics for your project data.
Managing Insights dashboards
Managing Insights dashboards
Insights reports
You can run insights reports include State of Sprint report and Security report in HCL™ Accelerate.
Releasing software
A release is a repeatable plan that is used to drive deployments.
Managing a release
Use the release details page to view details about a specific release.
Managing releases
Release management is the process of planning, scheduling, and controlling software deliveries.
Creating releases
Archiving releases
You can archive a release to remove it from the list of releases.
Events and tags
An event represents a release-related activity that you manage with the calendar. A tag is a label that you can add to a release or an event. You can use tags to filter the Activities list on the Releases page. Tags do not appear on the calendar.
Restoring archived releases, plans, and templates
You can restore archived releases, deployment plans, and templates.
Deployment plans
A deployment plan is a container for tasks. Tasks define the activities that your team runs to complete a software deployment.
Running deployments
Complete deployments by resolving the tasks in a deployment plan.
A task represents a business-meaningful activity that is associated with a software deployment. Each task is defined on a separate row in a deployment plan. During a deployment, you run tasks defined in the deployment plan to complete the deployment.
A deployment plan can contain user-defined properties. Properties values can be defined at design- or run-time.
Extending product functions
Learn how to extend the function of HCL™ Accelerate
Introducing plug-ins
Extend HCL™ Accelerate by configuring plug-in integrations to external tools.
Creating integrations
Work with external tools by defining integrations.
Deleting integrations
Delete no longer needed integrations.
Creating plug-ins
You can create your own plug-ins and install them in HCL™ Accelerate. After installing custom plug-ins, you can integrate them in your releases, reports, and value streams.
Managing native integrations
Native integrations add external functionality to releases, deployment plans, and pipelines.
Uploading data to the API
Upload metrics data by using an external client to access API endpoints.
Uploading a build to a pipeline
Uploading deployment status
How to
The topics in this section describe how to work with HCL™ Accelerate features. Tutorials and workbooks are available for users of all experience levels.
Accessing the user interface
The user interface provides access to reports.
Create a report
Use the Home page to create one of the following reports.
Filtering report data
Use filters to drill down into or broaden the information in the report.
Formatting Custom reports
You can organize the layout of report charts in custom reports to put information into a meaningful order.
Managing reports
Use the Home page to view, modify, and remove existing report. You can also create reports from this page.
Sharing reports
You can share reports with others in your organization and who are authenticated to HCL™ Accelerate. By default, you see only the reports that you create.
Before you contacting support, gather background information and perform tasks that will assist in solving the problem. It helps to be as specific as possible and include all relevant information.