Versions Compared

Key

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

The functions from which Transmuter Recipes are built are described below:

Transform Function

Description

Parameters

AddJobParameter

Adds a named parameter to one or more specified jobs

RemoveJobParameter

Removes a named parameter from one or more specified jobs

  • parameterName: The name of the parameter to remove

AppendToAttribute

Append a string value to an attribute.

  • xpath: Path to the attribute in the XML to modify

  • appendString: String to append to the current value of the attribute

PrependToAttribute

Prepend a string value to an attribute.

  • xpath: Path to the attribute in the XML to modify

  • prependString: String to prepend to the current value of the attribute

SearchAndReplace

Perform a regex search/replace on a text node (i.e. attribute or element with text content). If an element with child elements is provided by the xpath, the child elements will all be removed by this operation.

  • xpath: Path to the text node in the XML to apply search and replace

  • searchString: Regex search string

  • replaceString: Regex replace string

InsertElement

Adds an XML element as a child to a specified parent element.

  • xpath: Path to the parent node. The provided element will be a child of this node

  • element: XML element to insert (as a string)

InsertAttribute

Adds an attribute to an XML element. If the attribute already exists it will be overwritten.

  • xpath: Path to the element to add attribute to

  • attributeName: name of the attribute to add

  • attributeValue: value of the attribute to add

RemoveElement

Removes an XML element from the document.

  • xpath: Path to the element to remove.

RemoveAttribute

Removes an attribute from an existing element.

  • xpath: Path to the element the attribute is in.

  • attributeName: Name of the attribute to remove.

...