Skip to content

Structural operate operations

<operate> applies checked operation-control rows to XML or JSON template content. Every operation comes from the runtime registry; this page gives the exact parser form for an op... cell.

json

appendItem

Append one supplied value to every array matched by a JSONPath.

Control-cell form: appendItem(jsonpath, value)

Supply a JSONPath followed by the operation-specific value.

clearArray

Remove every item from each array matched by a JSONPath.

Control-cell form: clearArray(jsonpath)

Supply only the JSONPath; the matched container is cleared.

clearObject

Remove every property from each object matched by a JSONPath.

Control-cell form: clearObject(jsonpath)

Supply only the JSONPath; the matched container is cleared.

delete

Delete every property or array item matched by a JSONPath.

Control-cell form: delete(jsonpath)

Supply only the JSONPath; this operation has no value argument.

function

Execute a custom function on JSON content.

Control-cell form: {functionName}

Supply a registered function expression in braces instead of an operation call.

mergeObject

Merge the supplied JSON object into every object matched by a JSONPath.

Control-cell form: mergeObject(jsonpath, value)

Supply a JSONPath followed by the operation-specific value.

removeItem

Remove the first item equal to the supplied value from every matched array.

Control-cell form: removeItem(jsonpath, value)

Supply a JSONPath followed by the operation-specific value.

removeProperties

Remove a comma-separated set of property names from every matched object.

Control-cell form: removeProperties(jsonpath, value)

Supply a JSONPath followed by the operation-specific value.

replaceArray

Replace the contents of every matched array with the supplied JSON array.

Control-cell form: replaceArray(jsonpath, value)

Supply a JSONPath followed by the operation-specific value.

set

Set the value of every property or array item matched by a JSONPath.

Control-cell form: set(jsonpath, value)

Supply a JSONPath followed by the operation-specific value.

upsertProperty

Set a property or create the final property on an existing object path.

Control-cell form: upsertProperty(jsonpath, value)

Supply a JSONPath followed by the operation-specific value.

xml

appendChild

Append an XML fragment, or a text-wrapped item, below each matched element.

Control-cell form: appendChild(xpath, value)

Supply an XPath followed by the operation-specific value.

clearAttributes

Remove every attribute from each element matched by an XPath.

Control-cell form: clearAttributes(xpath)

Supply only the XPath; the matched container is cleared.

clearChildren

Remove all child nodes and text from each matched element.

Control-cell form: clearChildren(xpath)

Supply only the XPath; the matched container is cleared.

delete

Delete every element matched by an XPath from its parent.

Control-cell form: delete(xpath)

Supply only the XPath; this operation has no value argument.

function

Execute a custom function on XML content.

Control-cell form: {functionName}

Supply a registered function expression in braces instead of an operation call.

mergeAttributes

Add or overwrite quoted name=value attributes on each matched element.

Control-cell form: mergeAttributes(xpath, value)

Supply an XPath followed by the operation-specific value.

removeAttributes

Remove a comma-separated set of attribute names from each matched element.

Control-cell form: removeAttributes(xpath, value)

Supply an XPath followed by the operation-specific value.

removeChild

Remove child nodes selected by a relative XPath below each matched element.

Control-cell form: removeChild(xpath, value)

Supply an XPath followed by the operation-specific value.

replaceAttribute

Rename existing attributes using comma-separated old:new pairs.

Control-cell form: replaceAttribute(xpath, value)

Supply an XPath followed by the operation-specific value.

replaceChildren

Replace all child nodes of each matched element with XML fragments or text.

Control-cell form: replaceChildren(xpath, value)

Supply an XPath followed by the operation-specific value.

replaceNode

Replace each matched element with one well-formed XML element.

Control-cell form: replaceNode(xpath, value)

Supply an XPath followed by the operation-specific value.

set

Set the text content of every element matched by an XPath.

Control-cell form: set(xpath, value)

Supply an XPath followed by the operation-specific value.

upsertAttribute

Set a name=value attribute and create the final element when its parent exists.

Control-cell form: upsertAttribute(xpath, value)

Supply an XPath followed by the operation-specific value.

upsertNode

Set a matched node or create the final node below an existing parent XPath.

Control-cell form: upsertNode(xpath, value)

Supply an XPath followed by the operation-specific value.