Description

The File System (Versioned) source config plugin imports source artifacts with versions from a file system. You can manually or automatically import artifacts from the file system into a directory structure that represents the artifact versions.

Quick Info

Product
HCL Launch
Type
plugin
Compatibility
HCL Launch version 7.0 or later
Created by
HCL Software
Version Name Action

12.10268..;

launch-filesystemversionedsourceconfig-12.10268..>

14.11090..;

launch-filesystemversionedsourceconfig-14.11090..>

launch-filesystemversionedsourceconfig-12.10268..>

12.10268..;


launch-filesystemversionedsourceconfig-14.11090..>

14.11090..;


Overview

The File System (Versioned) plugin automates importing artifacts with versions and maintaining the versioning structure.

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

Compatibility

This plugin runs on HCL Launch version 7.0 or later.

This plugin is supported to run on all operating systems supported by the HCL Launch agent, except for z/OS.

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
12 Minor enhancements

Usage

When using a versioned file system, each subdirectory in the target directory is treated as a different version of the artifacts. You can set the server to check for new subdirectories periodically and automatically create component versions when new subdirectories are detected.

You need to define an HCL Launch component which defines the source and processes for the FileSystem repository. The component contains the information for importing the artifacts and any processes to implement on the artifacts.

To create a File System (Versioned) source configuration type of component arrange the artifacts inside a parent folder and subfolders based on the file system layout.


 myComponent/
    version n/
       files
    version n+1/
       files

For example, the following file structure shows a component with two versions and two files in each version. The two component versions are 1.0 and 2.0.


 myStaticWebContent/
    1.0/
      index.html
      logo.gif
    2.0/
      index.html
      logo.gif

To import artifacts with versions, create a directory with subdirectories that represent the versions of the artifacts. Then, create the component with the File System (Versioned) source configuration type.

After the component is created use the Components page in the user interface to import a version of the artifacts if automatic import was not selected.

Step palette

To access this plugin in the palette, click Source and Repositories > File System Versioned.

Create a component

To create a component, complete the following steps. For more information, see .

  1. In the HCL user interface, click Components and then click Create Component.
  2. In the Create Component window, specify a name and description for the component.
  3. In the Teams fields, specify the access information for the new component.
  4. To use a template for the new component, select a template from the Template list. In this case, the component inherits source configuration, properties, and processes from the template.
  5. In the Source Config Type list, select File System (versioned).

  6. Specify the properties for the component. See the Setting tab for descriptions.
  7. Click Save.

Import a version

When the artifacts are imported, a component version is created using the version of the package. You can specify to import a specific package version or import all versions. If importing all versions, a component version is created for each version.

  1. Click the Versions tab for the component.
  2. Click Import New Versions.
  3. Specify a specific version of the package to import, or leave blank to import the latest version of the package available in the repository. Additionally, enable Import All Versions to import all versions of a package.
  4. Click Save.

Steps

The following process steps are available in the File System (Versioned) plugin.

Import Version

This step has no input properties.

Settings and Roles

The plugin adds these roles automatically to resources. You cannot add these roles manually.

FileSystemVersionedComponentProperties

Properties for the FileSystemVersionedComponentProperties role
Name Type Description
Base Path String The path to the directory that contains the artifacts. The content of each subdirectory within the base directory is considered a distinct component version. The subdirectory with the most recent timestamp is considered to be the latest version.
Exclude Files String A list of files to exclude in the version upload. Separate each file with a comma or place on a separate line.
Include Files String A list of files to include in the version upload. Separate each file with a comma or newline character.The default setting is to uploads all files. You can use the asterisk or double-asterisk as wildcards to expand the number of files to upload. Specifying **/* uploads all files.
Preserve Execute Permissions Boolean For Linux and UNIX operating systems, enable this property to retain the execute permissions for each file.
Text File Extensions String A list of file extensions to convert into another character set. Separate each fle extension with a comma. Specify this property if you have text-type files that must be converted into another character set. Matching file types are converted into the default character set of the system where the agent is located.