Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »

Creates a build artifact containing file(s) and folder(s) selected on the Project Files tab of a project. This artifact is then used by the packageDeploy operation.

The project file attributes can be defaulted for the project using project properties. Then at populate or evaluate time, the defaults are used to fill the project file attributes. Those attributes are used at deploy time. The attributes are stored with the object, not the build, so it is possible to change the attributes and then deploy again without another build in between.

This operation can only be used in package deployment projects of type file.

Project Properties

Property Name

Property Code

Required

Description

Root Target Folder

FDFILE_ROOT_TARGET_FOLDER

No

The path in which to create and update file and folder objects. If left blank, the FD_TEMP_DIR will be used.

Unlike the rest of the properties on this operation, this one is not a default. Its value is pulled at deploy time, not populate and evaluate time.

Use Source Path Default

FDFILE_USE_SOURCE_PATH_DEFAULT

No

When populating or evaluating project files, default the Use source path value to this.

Defaults to true(checked ).

Ignore Failure Default

FDFILE_IGNORE_FAILURE_DEFAULT

No

When populating or evaluating project files, default the Ignore Failure value to this.

Defaults to false (unchecked ).

Owner:Group File Default

FDFILE_OWNER_GROUP_FILE_DEFAULT

No

When populating or evaluating Files, default the Owner:Group value to this.

Owner:Group Folder Default

FDFILE_OWNER_GROUP_FOLDER_DEFAULT

No

When populating or evaluating Folders, default the Owner:Group value to this.

Permissions File Default

FDFILE_PERMISSION_FILE_DEFAULT

No

When populating or evaluating Files, default the Permissions to this.

Permissions Folder Default

FDFILE_PERMISSION_FOLDER_DEFAULT

No

When populating or evaluating Folders, default the Permissions to this.

Property Replacement Default

FDFILE_PROPERTY_REPLACEMENT_DEFAULT

No

When populating or evaluating Files, default the Property Replacement option to this.

Defaults to true(checked ).

Execute Default

FDFILE_EXECUTE_DEFAULT

No

When populating or evaluating Files, default the execute option to this.

Defaults to false (unchecked ).

Inputs

Input Name

Input Code

Required

Description

File Filter

FDFILE_INP_FILE_FILTER

No

Wildcard compatible expression to select file(s). You can enter multiple filter expressions separated by ##. Leave empty to select all files. The ## performs an OR expression. This will filter Files or Directory names but not the path. (e.g. for "/this/is/a/test/path" if you use "path" it will filter it, if you use "/this/is/a/test/path" it will not)

Here are some examples and expected behaviors:

Filter Text

Result

.properties##.xml##.conf##.temp

selects all .properties, .xml, .conf, and .temp files and  folders.

*.war

selects all .war files

*.war##important.xml##readme.md

selects all .war files, important.xml, and readme.md

File Exclude Filter

FDFILE_INP_FILE_FILTER_EXCLUDED

No

Wildcard compatible expression to exclude file(s) OR folders. You can enter multiple filter expressions separated by ##. Leave empty to select all files. The ## performs an OR expression. This will filter Files or Directory names but not the path. (e.g. for "/this/is/a/test/path" if you use "path" it will filter it, if you use "/this/is/a/test/path" it will not)

Here are some examples and expected behaviors:

Filter Text

Result

svn##.git##*.temp

excludes any .temp, svn, .git files and folders

*.war

excludes all .war files

*.tmp##boring.xml##readme.md

excludes all .tmp, boring.xml, and readme.md files

Combining include and exclude filters

File Filer

File Exclude Filter

Result

.war##.jar

badProject

select all .war and .jar files, unless there is a folder named badProject in its path

.war##.ear

badProject.war

select all .ear and .war files, except badProject.war


*.tmp##boring.xml##readme.md

select everything except all .tmp files, boring.xml, and readme.md

*.war


select all .war files

Important.*

*.class

select all files that start with Important, unless they end in .class

Source Path

FDFILE_INP_SOURCE_PATH

Yes

The source directory to copy file(s) from. The FD_TEMP_DIR and FD_ARTIFACTS_DIR variables work great in this field.

Target Path

FDFILE_INP_TARGET_PATH

Yes

The target directory where file(s) are to be transferred. The FD_TEMP_DIR and FD_ARTIFACTS_DIR variables work great in this field.

Clean Directory

FDFILE_INP_CLEAN_DIRECTORY

No

Flag to indicate if the target path should be cleaned before copy.

Artifacts

This operation produces an artifact that will be stored in the artifacts repository. The artifact contains the files that were selected on the Project Files page.

Endpoint Selection 

This operation will select all available endpoints associated to the target.

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

Package Deployment File Object Type Details

The file plugin package-based project allows for deploying File and Folder type objects. This page explains the two types and their attributes.

  • Attributes
  • Folder Objects
  • Attributes

    • File Objects

    File type objects model files that are stored in SCM. They are used to copy files from an SCM to a filesystem on an endpoint. File objects can be sourced only from an SCM. They cannot be created manually. No attributes are required.

    Sub-folders to the final target location of the file are created by the plugin as long as the endpoint user has sufficient privileges.

    Attributes

    Name

    Description

    Default Value

    Target

    This is the location where the file will be placed. Property replacement will be performed on the value.

    If blank, the file will be copied into FD_TEMP_DIR. If the default is used, but the FDFILE_ROOT_TARGET_FOLDER project property is left blank, then the file will be copied into FD_TEMP_DIR.

    ${{FDFILE_ROOT_TARGET_FOLDER}}

    Use Source Path

    If this is NOT checked, the file will be placed directly in target.

    If it is checked, the whole File Name with path will be placed inside the target.

    Use Source Path Default is the project property to control the default.

    Owner:Group

    Set the owner or owner:group of the file to this value.

    This only work on Unix endpoints. On Windows endpoints, it is ignored.

    Owner:Group File Default is the project property to control the default.

    Permission

    Set the permissions of the file to this value.

    This only work on Unix endpoints. On Windows endpoints, it is ignored.

    If it is not set, and Execute is checked, chmod +x will be run on the file if it is a Unix endpoint.

    Permissions File Default is the project property to control the default.

    Property Replacement

    If checked, property replacement will be run on the file, unless it appears to be a binary file, and then it will be skipped for property replacement.

    Property Replacement Default is the project property to control the default.

    Execute

    If checked the file will be executed. This works on both Windows and Unix.

    Execute Default is the project property to control the default.

    Arguments

    Arguments appended to the execution if executed.

    Default value is empty.

    Ignore Failure

    If checked, the file and the execution will be marked successful even if it fails to be processed in any way. The failure will still be logged, but there will be no other indication.

    Ignore Failure Defaultis the project property to control the default.

    Folder Objects

    Folder objects are created manually. They cannot be populated from SCM, but it is possible to add a folder that replicates one in an SCM.

    You can "Create" a folder that already exists on the file system for the purpose of changing attributes on the existing directory. This can be done on folders that are created as part of the SCM structure, or any other folders desired on the file system.

    Attributes

    Name

    Description

    Default Value

    Target Location

    This is the location where the file will be placed. Property replacement will be performed on the value.

    If blank, the folder will be created in FD_TEMP_DIR. If the default is used, but the FDFILE_ROOT_TARGET_FOLDER project property is left blank, then the folder will be created in FD_TEMP_DIR.

    ${{FDFILE_ROOT_TARGET_FOLDER}}

    Owner:Group

    Set the owner or owner:group of the folder to this value.

    This only work on Unix endpoints. On Windows endpoints, it is ignored.

    Owner:Group Folder Default is the project property to control the default.

    Permission

    Set the permissions of the folder to this value.

    This only work on Unix endpoints. On Windows endpoints, it is ignored.

    Permissions Folder Default is the project property to control the default.

    File Path

    The folder path, it can be just ‘/foldername' or it can drill into other folders such as 'demo/foldername’

    No default value

    • No labels