Plug-in Documentation

Web Utilities

Overview

Use the Web Utilities plug-in to send HTTP requests to web servers in IBM UrbanCode Deploy processes.

This plug-in includes the following steps:

Compatibility

This plug-in requires IBM UrbanCode Deploy version 6.0.1 or later.

This plug-in is runs on all operating systems that the IBM UrbanCode Deploy agent supports.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode Deploy.

History

Version 15

  • New Delete from FTP Server step.

Version 14

  • Added Local Passive and Local Active data connection mode options to the Upload to FTP Server step.

Version 13

  • Fixes issue Send Http Call step appears to ignore setting contentType JSON resulting in responseStatus 415 unsupported media type.

Version 12

  • Fixes APAR PH01058 Send HTTP Call step corrupts downloaded binary files.

Version 11

  • Fixes APAR PI96481 Support specifying accept type as a parameter for Send HTTP Call.
  • Improved Logging.

Version 10

  • Support application/zip content type.

Version 9

  • Fixes APAR PI81182 Error in token authentication of the Send HTTP Call step.

Version 8

  • Fixes APAR PI74319 Error in Send HTTP Call when Http entity is null.

Version 7

  • Support property file encryption.
  • Fixed bug: Casting exception when given output file.
  • Fixed bug: Setting output properties.

Version 6

  • Fixed defect: untrustedSSL does not work in Web Utility plug-in
  • Fixed defect: Web Utility throws null point exception
  • Fixed defect: Web Utility plug-in doesnt encode JSON correct in zOS
  • Fixed defect: Web Utility throws null point exception
  • Fixed bug: Username and Password fields does not work in edge case
  • Fixes APAR PI68335: HTTP authorization header visible in deployment log
  • Fixed bug: Web Utilities plugin uses SSLv3 for Send HTTP Call

Version 5

This release adds the ability to upload a file to an FTP server.

Version 3

This release includes a fix for APAR PI35342, a compatibility defect with IBM Urbancode Deploy version 6.1.0.4 and later.

Version 2

This release includes the ability to specify a content type and fixes a defect related to HEAD requests.

Version 1

Initial release of the plug-in.

Steps

Process steps in the Web Utilities plug-in

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:

  • default
  • localPassive
  • localActive
  • ${p:componentProcess/connectionMode}
Select a data connection mode between the client and server. 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:

  • */*
  • 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
  • application/zip
Select the accept type. If there is no accept type, select ANY. 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:

  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • OPTIONS
Select the method to use for the HTTP request. 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:

  • */*
  • 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
  • application/zip
Select the body content type. If there is no request body, select ANY. 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:

  • default
  • localPassive
  • localActive
  • ${p:componentProcess/connectionMode}
Select a data connection mode between the client and server. No
FTP File Type Enumeration:

  • BINARY
  • ASCII
Select the FTP File Type to be sent to the FTP Server. 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

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 (i.e. newFileName.zip instead of just newFileName).

Step palette

To access this plug-in step in the palette, click Utilities > Web Utilities.