stringReplacement

Replaces strings in files in a specific folder. See the Appendix for details about how to create the filters necessary to select the files you wish.

The string that is used as the needle can be a plain string or a regular expression.

This operation is suitable for files < 100MB, but not for very large files. The files are stored fully in memory during the replacement. Matching files are overwritten with the modified text. Files that seem to be binary in nature are skipped in this operation.

  

Environment/Instance Properties

Property Name

Property CodeRequired

Description





  

Project Properties

Property Name

Property Code

Required

Description





  

Inputs

Input Name

Input Code

Required

Description

Source Path

FDFILE_INP_SOURCE_PATH

No

The source directory path, files in this folder are eligible for property replacement. The FD_TEMP_DIR and FD_ARTIFACTS_DIR variables work great in this field.

File Filter

FDFILE_INP_FILE_FILTER

No

Wildcard compatible expression to select file(s). You can enter multiple filter expressions separated by ##. Leave empty to select all files. The ## performs an OR expression.

See the Filter Examples at the end of the document.

File Exclude Filter

FDFILE_INP_FILE_FILTER_EXCLUDED

No

Wildcard compatible expression to exclude file(s) OR folders. You can enter multiple filter expressions separated by ##. Leave empty to select all files. The ## performs an OR expression.

See the Filter Examples at the end of the document.

Needle TextFDFILE_INP_REPLACE_NEEDLEYesThe string or regular expression to search for in the files
Replace TextFDFILE_INP_REPLACE_TARGETNoThe text that will replace the matches the plugin operation finds. Leaving it blank is acceptable, all the matches will be deleted in this case.
Whole Word OnlyFDFILE_INP_REPLACE_WHOLE_WORD_ONLYNo

Should matches only be found when surrounded by word boundaries such as a space, punctuation, or the beginning or end of a line?

Case InsensitiveFDFILE_INP_CASE_INSENSITIVENoShould matches be performed case-insensitively?
Quote PatternFDFILE_INP_QUOTE_PATTERNNoIf true, the needle will be treated literally as a string. If false, the needle is a regular expression.

  

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.

  

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.