Versions Compared

Old Version 1

changes.mady.by.user Karl Henselin

Saved on

compared with

New Version Current

changes.mady.by.user Chandresh Patel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Table of Contents

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

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

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

OWNER

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

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

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

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

ARGS

Arguments appended to the execution if executed.

Default value is empty.

Ignore Failure

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

Code

Description

Default Value

Target Location

TARGET

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

OWNER

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

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