Versions Compared

Key

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

...

  • PROJECT_TYPE - Partial deploy project type, GENERIC, EBS, MDS etc
  • OBJECT_TYPE_CODE - Object type for the File.
  • File level attributes
    • FILE_PATH - File path of the partial deploy file. (File Name (with path)) on the partial deployment screen.
    • FILE_NAME - File name of the partial deploy file
    • FILE_PATH_PREFIX - File path,
     discluding
    • excluding the file name and extension
    • FILE_EXTENSION - File extension on the partial deploy file.
    • SOURCE_FILE - Fully qualified location of the file on the endpoint
    .  

...

    • .
    • FILE_HASH - The Hash of the file as generated recorded by FlexDeploy - Added in 5.0.4
    • FILE_SCM_REVISION - The SCM Revision of the partial deploy file - Added in 5.0.4
  • All file attributes defined on Project Files tab are included as well.

File level variable example

Environment VariableValue if File Name (with path) is /XXHR/publisher/APXSOBLX_1.rtf
FILE_PATH/XXHR/publisher/APXSOBLX_1.rtf
FILE_NAMEAPXSOBLX_1
FILE_PATH_PREFIX/XXHR/publisher
FILE_EXTENSIONrtf
SOURCE_FILE<Workflow Execution Temp Directory>/XXHR/publisher/APXSOBLX_1.rtf

Environment/Instance Properties

Property Name

Property Code

Required

Description





...

Property Name

Property Code

Required

Description

Project File Includes

FD_PARTIAL_FILE_INCLUDES

No

Controls files included in Project Files. Enter expressions separated by ##. Leave empty to select all files. Begin or end the expression with * for simple wildcards. Otherwise, regex
is used. (e.g. /java/*##*.java##*person*##/java/.*[tT]est.*\.java)

Project File ExcludesFD_PARTIAL_FILE_EXCLUDESNoControls files excluded from Project Files. Enter expressions separated by ##. Leave empty to select all files. Begin or end the expression with * for simple wildcards. Otherwise,
regex is used. (e.g. /java/*##*.java##*person*##/java/.*[tT]est.*\.java)
Stop On Deployment ErrorFDSHELL_STOP_ON_DEPLOYMENT_ERRORNoStop deploying package files if any error occurs. If unchecked all files will be deployed even if one or more files fails. This is for partialExecute operations only.

Inputs

Input Name

Input Code

Required

Description

Code Snippet

FDWSHELL_INP_CODE_SNIPPET

Yes

The commands and/or bat scripts that are to be executed in a Windows environment.

Restrict Environment

FDWSHELL_INP_RESTRICT_ENVIRONMENT

No

Provide comma-separated instance codes to restrict environment variables in shell to specified instance codes. If no value is provided all properties are available to shell environment.

No Secure Variables

FDWSHELL_INP_NO_SECURE_VARIABLES

No

Check if you do not want to pass secure/encrypted properties in shell environment.

Anchor
_GoBack
_GoBack

Perform Property ReplacementFDSHELL_INP_PERFORM_PROPERTY_REPLACEMENTNoCheck to perform property replacement on source file before execution of script.

Outputs

Output Name

Required

Description

User Defined

No

See Special Considerations below.

...

Code Block
languagepowershell
titleOutput Syntax
setOutput {output name} {output value} 

#Example 
Call: setOutput STATUSRESULT %{STATUSRESULT_VARIABLE}%

Outputs are aggregated into a csv CSV list for partial deployments.

The above STATUS RESULT example would contain an entry for each file in the object list.  [SUCCESS, FAIL, SUCCESS, SUCCESS]YES, NO]

Code Block
languagebash
titleIndicate file was not processed and should not consider status
# just call ignoreStatus for File that this shell did not process
ignoreStatus

Overriding the file status

There may be cases when you want to manually set the status for any particular file when scripting.  The below functions can be utilized to set the status of the file as you see fit:

Code Block
languagebash
Call: setObjectResultStatusSuccess
Call: setObjectResultStatusFailed
Call: setObjectResultStatusSkipped
Call: setObjectResultStatusNotAttempted
Call: setObjectResultStatusIgnore