File Package-Based Project Object Types
- Karl Henselin
- Emily Simon
The file plugin package-based project allows for deploying File and Folder type objects. This page explains the two types and their attributes.
- 1 File Objects
- 1.1 Attributes
- 2 Folder Objects
- 2.1 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 | Â |
Â
- style