Description

The File System source config plugin enables one to manually import artifacts from the file system into a folder. The artifacts are not stored into version folder, using this plugin you must manually create versions. To import artifacts into version folders, use the File System (Versioned) plugin.

Quick Info

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

7.1026823

launch-filesystemsourceconfig-7.1026823.zip

8.1109006

launch-filesystemsourceconfig-8.1109006.zip

launch-filesystemsourceconfig-7.1026823.zip

7.1026823


launch-filesystemsourceconfig-8.1109006.zip

8.1109006


Summary

The File System plugin imports artifacts from a local filesystem. The imported artifacts are stored in a single folder. If you want to store artifacts into versioned folders, you must manually create the version folders.

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.

The agent must be on a system running Microsoft Windows.

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

Usage

To use this plugin, create a component to define the File System artifacts to be used. The component contains the information for importing the artifacts and any processes to perform on the artifacts.

To import artifacts that are not stored in versioned folders, store the artifacts in a folder and create a component with the File System source configuration type.

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.

  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.

Step palette

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

Steps

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

Import Version

Creates a new component version and imports artifacts

This step has no input properties.

Settings and Roles

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

FileSystemComponentProperties

Properties for the FileSystemComponentProperties role
Name Type Description
Always Use Name Pattern Boolean A name is automatically assigned to a new version. The name assigned is based on the pattern specified in the Version Name Pattern field. If this property is not enabled, you must specify a name each time you create a version.
Base Path String The path to the directory that contains the artifacts.
Extensions of files to Convert String A list of file extensions to convert into another character set. Separate each file 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.
Next Version Number String The version number for the next version. This property is meaningful only when the Always Use Name Pattern property is enabled.
Preserve Execute Permissions Boolean For Linux and UNIX operating systems, enable this property to retain the execute permissions for each file.
Version Name Pattern String A pattern for each version name. You can use the ${version} variable to include an automatically incremented version number. For example, the mycomp_${version} pattern produces versions such as mycomp_1, mycomp_2, and so on. This parameter is meaningful only if the Always Use Name Pattern property is enabled.

FileSystemImportProperties

Properties for the FileSystemImportProperties role
Name Type Description
Version Description String The description for this version.
Version Name String The name for this version.