Plug-in Documentation

IBM UrbanCode Deploy Versioned File Storage

 

Overview

The steps in this plug-in work with versioned components. For example, the Download Artifacts step retrieves the latest version of a component. Most component deployment processes use this step to download the component artifacts to the agent system.

Note: For AIX systems, file permissions defined at the operating system level are not supported by the UrbanCode Deploy Versioned File Storage plug-in. The plug-in uses the permissions set by a process or script. The chmod command can be used to reset a permission to the value defined at the operating system level.

To add the IBM UrbanCode Deploy Versioned File Storage plug-in steps to processes, click Repositories > Artifact > IBM UrbanCode Deploy in the step palette of the process editor.

Compatibility

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

This plug-in is supported to run on all operating systems that are supported by the IBM UrbanCode Deploy agent.

Installation

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

History

Version 33.1063337

Enhanced Download Artifacts to support incremental versions in sync mode.

Version 32.1057040

Enhanced Download Artifacts for zOS step to extract files for new package format.

Version 31.1001746

Version 31 includes a fix for APAR PI92703. Add retry to artifact downloads after an IOException. The step will now fail after 5 attempts to download the artifact set.

Version 30.972885

Version 30 renames the plugin.

Version 29.941549

Version 29 includes a fix for APAR PI85953. Fix infinite loop in Download Artifacts if the user did not have permissions to the working directory.

Version 28.858562

Version 28 includes support for property file encryption.

Version 27.816399

Version 27 includes an enhancement to the Download Artifacts for zOS step to support HFS files.

Version 26.785274

Version 26 includes a fix for APAR PI54866. Logging no longer shows message for deleting a directory if that directory does not get deleted.

Version 23.673430

This release includes functions in the Download Artifacts step for minimal compatibility with configurations created in versions of the product earlier than 6.1.

Version 21.623414

This release includes a fix for an issue where the initial character in a file name that is specified in the Download Artifacts step is dropped.

Steps

Process steps in the UrbanCode Deploy Versioned File Storage plug-in

Download Artifacts

Download artifacts from a VFS server.

Input properties for the Download Artifacts step
Name Type Description Required
Artifact Directory Offset String The base directory from which artifacts will be retrieved from the Component Version.
For example, using App/Dist will only get all files from in the App/Dist directory
and put them in the Current Working Directory. All includes/excludes will be evaluated
relative to this offset.
No
Charset String The Character set that files whose metadata includes a character set should be converted
to upon download (e.g. UTF-8). If this field is left blank then the system’s default
charset will be used.
No
Directory Offset String The working directory to use when executing this command. This is relative to current
working directory.
Yes
Excludes String The patterns to exclude files to upload. No
Full Verification Boolean (Valid only with Sync Mode enabled) When selected, hashes will be computed on each
file in the destination artifact set to determine whether network transfer is necessary.
Otherwise, files will be compared by date modified and size.
No
Handle Incremental Versions Boolean (Valid only with Sync Mode enabled) When selected, incremental version handling is
enabled. When not selected, the legacy behavior is enabled, which is to handle incremental
versions as though they are full versions. Enabling incremental version handling has
two effects. First, when deploying a full version, all versions back to the most recently
deployed full version are considered when determining which files to update or remove;
the legacy behavior will only consider the the single most recently deployed version.
Second, deploying an incremental version will not remove files from all currently
deployed versions and will restore missing files from those versions; the legacy behavior
will remove files from the single most recent currently deployed version and ignore
files from other currently deployed versions. For server versions before 7.1.1.0,
there is a negative performance impact to enabling this feature due to API availablity.
The impact is the greatest for versions 6.2.7.0 through 7.1.0. Until 7.1.1.0, is not
recommended to enable this feature unless you use incremental versions.
No
Includes String The patterns to match files to upload. The wildcard ** indicates every directory and
the wildcard * indicates every file. So the pattern dist/**/* would retrieve the entire
file tree underneath the dist directory.
Yes
Set File Execute Bits Boolean When enabled, sets file execute bits on the files which have them set in the repository. No
Sync Mode Enumeration:

  • false
  • true
  • FULL
Sync transfers only changed files, removing files that exist only in the previously
deployed version. Clean removes all files not contained in the currently deployed
version
No
Verify File Integrity Boolean When enabled, verifies downloaded files match their hash. Enabling this may reduce
performance.
No

Download Artifacts for zOS

Download zOS component artifacts from a VFS server.

zOS

Input properties for the Download Artifacts for zOS step
Name Type Description Required
Directory Offset String The working directory to use when executing this command. This is relative to current
working directory.
Yes

Sync Artifacts

Compare local artifacts with the artifacts expected to be on the resource according
to its inventory, and remediate any differences.

Input properties for the Sync Artifacts step
Name Type Description Required
Charset String The Character set that files whose metadata includes a character set should be converted
to upon download (e.g. UTF-8). If this field is left blank then the system’s default
charset will be used.
No
Excludes String The patterns to exclude files to upload. No
Includes String The patterns to match files to upload. The wildcard ** indicates every directory and
the wildcard * indicates every file. So the pattern dist/**/* would retrieve the entire
file tree underneath the dist directory.
Yes
Set File Execute Bits Boolean When enabled, sets file execute bits on the files which have them set in the repository. No
Verify File Integrity Boolean When enabled, verifies downloaded files match their hash. Enabling this may reduce
performance.
No

Upload Artifacts

Upload artifacts to a VFS server.

Input properties for the Upload Artifacts step
Name Type Description Required
Directory Offset String The working directory to use when executing this command. This is relative to current
working directory.
Yes
Excludes String The patterns to exclude files to upload. No
Includes String The patterns to match files to upload. The wildcard ** indicates every directory and
the wildcard * indicates every file. So the pattern dist/**/* would retrieve the entire
file tree underneath the dist directory.
Yes
Save File Execute Bits Boolean When enabled, file execute bits are saved with the files. No
Text File Extensions String A comma separated list of extensions of files need to be converted to a new character
set on download (e.g. txt,properties,log). This should be used in cases where the
OS the files are being deployed to requires a different character set than the one
uploading the files into the server.
No

Verify Local Artifacts

Compare artifacts on local machine with inventory.

Input properties for the Verify Local Artifacts step
Name Type Description Required
Directory Offset String The working directory to use when executing this command. This is relative to current
working directory.
Yes
Excludes String The patterns to exclude files to upload. No
Includes String The patterns to match files to upload. The wildcard ** indicates every directory and
the wildcard * indicates every file. So the pattern dist/**/* would retrieve the entire
file tree underneath the dist directory.
Yes