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 |
| 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 |
| No | When populating or evaluating project files, default the Use source path value to this. Defaults to true(checked ). |
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 |
| No | When populating or evaluating Files, default the Owner:Group value to this. |
Owner:Group Folder Default |
| No | When populating or evaluating Folders, default the Owner:Group value to this. |
Permissions File Default |
| No | When populating or evaluating Files, default the Permissions to this. |
Permissions Folder Default |
| No | When populating or evaluating Folders, default the Permissions to this. |
Property Replacement Default |
| No | When populating or evaluating Files, default the Property Replacement option to this. Defaults to true(checked ). |
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 |
| 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) |
File Exclude Filter |
| 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) |
Source Path |
| Yes | The source directory to copy file(s) from. The |
Target Path |
| Yes | The target directory where file(s) are to be transferred. The |
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.
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 | Code | 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 |
|
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. |
|
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. |
|
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. |
|
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. |
|
Execute |
| If checked the file will be executed. This works on both Windows and Unix. |
|
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. |
|
Rollback Source Type |
| Where to retrieve file when initiating a rollback deployment. Options are Project Version, SCM Revision, Backup Repository, and Rollback File SCM Revision and Rollback File options are only available when the project has SCM details configured, and Backup Repository should only be used if the FlexDeploy server and project are configured to take backups. | Project Version
|
Rollback File |
| The associated file to deploy which will roll back this file. Only applicable when Rollback Source Type is Rollback File |
|
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 | Code | 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 |
|
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. |
|
Permission |
| Set the permissions of the folder to this value. This only work on Unix endpoints. On Windows endpoints, it is ignored. |
|
Rollback Source Type |
| Where to retrieve file when initiating a rollback deployment. Options are Project Version, SCM Revision, Backup Repository, and Rollback File SCM Revision and Rollback File options are only available when the project has SCM details configured, and Backup Repository should only be used if the FlexDeploy server and project are configured to take backups. | Project Version
|
Rollback File |
| The associated file to deploy which will roll back this file. Only applicable when Rollback Source Type is Rollback File |
|