Usage

To use the HCL DevOps Test Integrations and APIs plugin, the plugin must be loaded and an instance created before you can configure the plugin integration. Configuration properties are defined using the product user interface or a JSON file. After the integration is complete, to invoke the plugin send an HTTP Post request to the plugin endpoint.

Integration type

The HCL DevOps Test Integrations and APIs plugin supports endpoint integration which are listed in the following table.

Invoking the plugin

To import data from the HCL DevOps Test Integrations and APIs server, send an HTTP POST request to your endpoint such as the following sample.

https://<pluginEndpoint>/onetest-api/callback

The payload for the POST is shown below.

{
    "project": "<Project Name>",
    "startDate": "<Start Date>" // Optional - Format is "YYYY-MM-DD"
}

Integration

To install the plug-in, perform the following steps:

1. In HCL DevOps Velocity, click Settings > Integrations > Available.
2. In the Action column for the HCL DevOps Test Integrations and APIs plug-in, click Install.

There are two methods to integrate the plug-in:

• Using the user interface
• Using a JSON file

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

Integrating the plug-in by using user interface

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

To integrate the plug-in using the user interface, perform the following steps:

1. In HCL DevOps Velocity, click Settings > Integrations > Installed.
2. In the Action column for the HCL DevOps Test Integrations and APIs plug-in, and then click Add Integration.
3. On the Add Integration dialog, enter the values for the fields to configure the integration and define communication.
4. Click Add.

Integrating the plug-in by using 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 plugin properties can be defined. Refer to the JSON sample code in the Configuration Properties section.

To integrate the plug-in using a JSON, perform the following steps:

1. Navigate to value stream page, and then click the necessary value stream.
2. Click  icon, and then Select Edit value stream to modify the JSON file in the code or tree view editors.
   Alternatively, you can also click Download JSON option to download the JSON file, and then select the Import JSON option to upload the revised JSON file.
3. Edit the integration information in the JSON file to add the plug-in configuration properties. Refer to JSON sample code in the Configuration Properties section more details.
4. Click Save.

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 HCL DevOps Test Integrations and APIs Configuration Properties table describes the configuration properties that define the connection and communications with the HCL DevOps Test Integrations and APIs. 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.

Example

The following cURL command can be used as an example to send a HTTP POST request to the endpoint.

curl --insecure --request POST --url "https://localhost/reporting-consumer/pluginEndpoint/5fbe581479d90350dd187e67/onetest-api/callback" --header "Content-Type: application/json" --data-raw "{ \"project\": \"Onetest\", \"startDate\": \"2020-09-30\" }"