Search and Replace

Search and Replace Action tasks are used to locate and replace strings of data within the job file and to replace them with other strings of data. Note that this Action task cannot be used with binary files.

For more advanced search and replace functionality, see Advanced Search and Replace.

Input

Any text-based file can be used in this task, even formats that are not directly compatible with PlanetPress. As long as the text is visible in a text-based editor (such as Notepad), it is readable and supported by this task.

Processing

The appropriate changes are made to the data file (replacing text).

Output

The modified data file is output from this task. Metadata is not modified in any way if it is present.

Task properties

General Tab
  • Find: Enter the string of data for which to search. You can use any combination of text, variables and data selections; see Variable task properties.
  • Replace with: Enter the string of data to use as a replacement. Since this is also a variable property box, the same as above applies.
  • List of words to find and replace: Lists each string to find, and its replacement. These are executed in order, from top to bottom.
    • Find: Enter the string of data for which to search. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these.
    • Replace with: Enter the string of data to use as a replacement. Since this is also a variable property box, the same as above applies.
  • button: Click to add a new line to the list of words to find and replace.
  • button: Click to remove the currently selected line from the list.
  • button: Move the currently selected line up one position.
  • button: Move the currently selected line down one position.

On Error Tab

For a description of the options on the On Error tab see Using the On Error tab.

Miscellaneous Tab

The Miscellaneous tab is common to all tasks.

It contains a text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button and are displayed in The Task Comments Pane.

Check the option Use as step description to display the text next to the icon of the plugin in the Process area.

The tab also provides an option to highlight the task in The Process area with the default color, set in the Preferences (see Colors), or the color selected or defined under Highlight color on this tab.
To revert the selected highlight color to the default color, open this tab, turn the Highlight option off and close the dialog with the OK button; then turn highlighting back on.
Highlighting can also be turned on and off via the task's contextual menu and with the Highlight button on the View ribbon.