execute

Runs user-specified groovy script. 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.

All Workflow Execution variables and Inputs are available in Groovy script. Refer to the FlexDeploy Variables Guide for more details.

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

FDGROOVY_INP_CODE_SNIPPET

Yes

The groovy code to be executed.
Example:

 def sampleDir = new File('DirectoryName') 
 def sampleDirSize = sampleDir.directorySize() 
 println sampleDirSize 
 outputs.put("STATUS", sampleDirSize)
ClasspathFDGROOVY_INP_CLASSPATHNoAdditional classpath(s) to use java libraries. Classpaths can be separated by semicolons or colons. Classpath entries may contain a wildcard (*).

Outputs

Output Name

Required

Description




Artifacts

This operation delegates the consumes/produces artifacts decisions 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.  

Endpoint Selection

This operation delegates endpoint selection to the workflow developer. The workflow editor will default the selection to "All", which selects all available endpoints associated to the environment instance. Selecting a specific resource will result in selection of endpoints associated to the environment instance which have that resource defined.

Endpoint Execution

This operation delegates endpoint execution to the workflow developer. The workflow editor will default to "Any", which will execute on any one of the selected endpoints, which will be randomly picked from selected endpoints or a specific endpoint where previous step may have executed. Changing this value to "All" to will result in execution on all selected endpoints.

Special Considerations

User defined outputs – an output must be defined in the workflow editor to be accessible. Within your script, an outputs map is available to add your outputs. Add an output value in outputs map and it will be returned to the workflow process. Any number of outputs can be defined, which makes this plugin very useful as it can be customized to perform actions that may not be supported out of box by FlexDeploy.

Example on how to set Output
 outputs.put("STATUS", STATUS_VARIABLE)