Description

The Web Utilities plugin automates interactions with websites and web services during a deployment.

Quick Info

Product
HCL Launch
Type
plugin
Compatibility
HCL Launch version 7.0 or later
Created by
HCL Software
Website
Updated Date
May 31, 2021
Version Name Modified date Action

16.1100888

launch-web-utilities-16.1100888.zip 16-Mar-2021 07:22

16.1107121

launch-web-utilities-16.1107121.zip 19-May-2021 06:18

launch-web-utilities-16.1100888.zip

16.1100888


launch-web-utilities-16.1107121.zip

16.1107121


Summary

Use the Web Utilities plugin to send HTTP requests to web servers in HCL Launch processes.

This plugin includes one or more steps, click Steps for step details and properties.

Compatibility

This plugin requires HCL Launch version 7.0 or later.

This plugin runs on all operating systems that the HCL Launch agent supports.

Installation

See Installing plugins in HCL Launch for installing and removing plugins.

History

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

Plugin history details
Version Description
16 Minor enhancements

Usage

Use the Send HTTP Call step to specify an HTTP request and send the request to a web server. You can invoke a RESTful service against a specified URL and write the results to a file. You can use RESTful service calls to integrate with any technology that has a REST-based API.

The step response is available in the responseBody property. A payload with an HTTP response is not always returned. Sometimes only an HTTP status code is expected.

Use the Upload to FTP Server step to specify a file on the agents local file system to upload to an FTP server specified by the Hostname. The file will be uploaded to the directory on the FTP server specified by the File Path. You can optionally rename the file by specifying the Rename File. Note the extension must be explicitly stated in the Rename File property, for example: newFileName.zip instead of just newFileName.

Step palette

To access this plugin in the palette, click Utilities > Web Utilities.

Steps

The following process steps are available in the Web Utilities plugin.

Delete from FTP Server

Uploads a file to an FTP server.

Input properties for the Delete from FTP Server step
Name Type Description Required
Connection Mode Enumeration Select a data connection mode between the client and server. Valid values are default, localPassive, localActive, and ${p:componentProcess/connectionMode}. No
Delete Directory Boolean Delete the directory if it is empty. No
Directory String The directory path where the files reside. Yes
File Names String List the file names to delete. Separate multiple file names
using commas or new lines.
No
Hostname String The host name of the FTP server. Yes
Password Password Password to authenticate with the FTP server. Yes
Port String The port the FTP server listens on. Yes
Username String User name to authenticate with the FTP server. Yes

Send HTTP Call

Sends an HTTP request to a URL, with headers and data.

Input properties for the Send HTTP Call step
Name Type Description Required
Accept Response Type Enumeration Select the accept type. If there is no accept type, select ANY. Types are */*, text/plain, application/x-www-form-urlencoded, application/xml,text/xml,application/xhtml+xml,application/atom+xml, application/json, application/javascript,text/javascript, text/html, and application/zip. No
Allow Untrusted SSL Certs Boolean If selected, HTTPS requests to sites with untrusted certificates do not fail. No
Data / Data File String The data to send with the HTTP request. Specify the data in text format, or specify
the name of a file that contains the data.
No
HTTP Method Enumeration Select the method to use for the HTTP request. Valid values are GET, POST, PUT, DELETE, HEAD, and OPTIONS. No
Headers String A list of request headers, separated by newline characters. No
Output File String Specify the name of a file, relative to the working directory or absolute, to use
to store the response body.
No
Password Password Password for basic authentication. No
Request Content Type Enumeration Select the body content type. If there is no request body, select ANY. Types are */*, text/plain, application/x-www-form-urlencoded, application/xml,text/xml,application/xhtml+xml,application/atom+xml, application/json, application/javascript,text/javascript, text/html, and application/zip. No
URL String The full URL to send the HTTP request. Yes
Username String User name for basic authentication. No

Upload to FTP Server

Uploads a file to an FTP server.

Input properties for the Upload to FTP Server step
Name Type Description Required
Connection Mode Enumeration Select a data connection mode between the client and server. Valid values are default, localPassive, localActive, and ${p:componentProcess/connectionMode}. No
FTP File Type Enumeration Select the FTP File Type to be sent to the FTP Server. Valid values are BINARY and ASCII. No
File Path String The full path of the local file to upload. For example: dir1/dir2/myFile.zip Yes
Hostname String The host name of the FTP server. Yes
Password Password Password to authenticate with the FTP server. Yes
Port String The port the FTP server listens on. Yes
Rename File String Upload the local file to the FTP server with another name. File extension needs to
be included.
No
Upload Directory String The structure for the directory destination on the FTP server, relative to the server
root directory. For example: /dir1/dir2/dir3/
Yes
Username String User name to authenticate with the FTP server. Yes