Versions Compared

Key

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

execute

Executes user-provided shell commands and/or existing scripts on a UNIX server. The plugin provides the ability for the user to define additional inputs that will be available to the scripts when executing. In addition, the plugin provides the ability for the user to define any number of outputs from the execution of the script that could be utilized in subsequent steps in the workflow.

...

Environment/Instance Properties

Property Name

Property Code

Required

Description





  

Project Properties

Property Name

Property Code

Required

Description





  

Inputs

Input Name

Input Code

Required

Description

Code Snippet

FDSHELL_INP_CODE_SNIPPET

Yes

The commands and/or scripts that are to be executed on the Unix server.

Stop on Error

FDSHELL_INP_STOP_ON_ERROR

No

Flag that indicates whether the script should stop on an error or continue on processing.

Disable Echo

FDSHELL_INP_DISABLE_ECHO

No

Flag that indicates to disable echo of each command as it executes. Echo of commands can be very useful tool to identify where shell script has failed during execution as well it helps with debugging. If you do not want to see this echo, you can select this input.

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.

  

Outputs

Output Name

Required

Description




  

Artifacts

This operation delegates consumes/produces artifacts decision to the workflow developer. Check Consumes Artifacts on the workflow step editor if this operation requires artifacts to be delivered prior to execution of the script. Check Produces Artifacts on the workflow step editor if this operation creates artifacts. The artifacts folder is available via the FD_ARTIFACTS_DIR variable.

...

User defined outputs – an output must be defined in the workflow editor to be accessible. Within your script, use the following built-in function to set the output with the appropriate value and have it returned to the workflow process. Any number of outputs can be used.


Code Block
languagebash
titleOutputs Syntax
setOutput {output name} {output value}
Example: setOutput STATUS


#Example
setOutput STATUS ${STATUS_VARIABLE}