\n70%

\n\n

Transforms a model based on a specified expansion rules objects.

\n\njavascriptwhitenone

\n\n

File name: ModelTransformations.js

\n\n

Parameters

\n\n

borderless-tableINLINE\n

\n\n\n\n\n\n\n\n\n

`model`	(Object) the model to transform
`rules`	(Object) a rules object containing instructions on how to transform the model (see below for more information)

\n\n

Return Value

borderless-tableINLINE\n

\n\n\n\n\n

Object

the transformed model

\n\n\n5%\n\n

","reason":"A section macro in a rich body macro can't be created or edited in the new editor."}}},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Rules","type":"text"}]},{"type":"paragraph","content":[{"text":"Rules objects take the form of:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n{\n \"target.path\": \"value.el.path\" || {\n expander: {\n type: \"expander.function.path\",\n ...\n }\n }\n}\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Transformation Expanders","type":"text"}]},{"type":"paragraph","content":[{"text":"The Framework currently provides the following expanders that can be used as part of a model transformation.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fluid.model.transform.value","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fluid.model.transform.arrayValue","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fluid.model.transform.firstValue","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fluid.model.transform.merge","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"Each of these is described below.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"fluid.model.transform.value","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"This extracts and/or the value of a given path, and can be used for the following purposes:","type":"text"}]},{"type":"paragraph","content":[{"text":"To rename a property:","type":"text","marks":[{"type":"strong"}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"nestedContent":{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"section","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Section"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Start:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nvar source = {\n cat: \"meow\",\n ...\n}\n","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"\n","type":"text"},{"type":"hardBreak"},{"text":"\n","type":"text"},{"text":">>","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Rule to rename \"cat\" to \"feline\":","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nvar rules = {\n feline: { \n expander: {\n type: \"fluid.model.transform.value\",\n // specify only the path to transform\n path: \"cat\"\n }\n },\n ....\n}\n","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"\n","type":"text"},{"type":"hardBreak"},{"text":"\n","type":"text"},{"text":">>","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Result:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n{\n feline: \"meow\",\n ...\n}\n","type":"text"}]}]}]}],"version":1},"cxhtml":"

Start:

\njavascript

\n
\n>>

Rule to rename "cat" to "feline":

\njavascript

\n
\n>>

Result:

\njavascript

","reason":"A section macro in a rich body macro can't be created or edited in the new editor."}}},{"type":"paragraph","content":[{"text":"To set a default value:","type":"text","marks":[{"type":"strong"}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"nestedContent":{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"section","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Section"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Start:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nvar source = {\n gerbil: undefined,\n // or if \"gerbil\" doesn't exist\n ...\n}\n","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"\n","type":"text"},{"type":"hardBreak"},{"text":"\n","type":"text"},{"text":">>","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Rule to set default value of \"gerbil\":","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nvar rules = {\n gerbil: { \n expander: {\n type: \"fluid.model.transform.value\",\n // specify path and default value\n path: \"gerbil\",\n value: \"squeek\"\n }\n },\n ....\n}\n","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"\n","type":"text"},{"type":"hardBreak"},{"text":"\n","type":"text"},{"text":">>","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Result:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n{\n gerbil: \"squeek\",\n ...\n}\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that if \"gerbil\" has a value initially, it will be unaffected.","type":"text"}]}]}]}],"version":1},"cxhtml":"

Start:

\njavascript

\n
\n>>

Rule to set default value of "gerbil":

\njavascript

\n
\n>>

Result:

\njavascript

Note that if "gerbil" has a value initially, it will be unaffected.

","reason":"A section macro in a rich body macro can't be created or edited in the new editor."}}},{"type":"paragraph","content":[{"text":"To specify a literal value:","type":"text","marks":[{"type":"strong"}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"nestedContent":{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"section","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Section"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Start:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nvar source = {\n // no mention of kangaroos\n ...\n}\n","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"\n","type":"text"},{"type":"hardBreak"},{"text":"\n","type":"text"},{"text":">>","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Rule to set a value for \"kangaroo\":","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nvar rules = {\n kangaroo: { \n expander: {\n type: \"fluid.model.transform.value\",\n // specify only a value\n value: \"boingg\"\n }\n },\n ....\n}\n","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"\n","type":"text"},{"type":"hardBreak"},{"text":"\n","type":"text"},{"text":">>","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Result:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n{\n kangaroo: \"boingg\",\n ...\n}\n","type":"text"}]}]}]}],"version":1},"cxhtml":"

Start:

\njavascript

\n
\n>>

Rule to set a value for "kangaroo":

\njavascript

\n
\n>>

Result:

\njavascript

","reason":"A section macro in a rich body macro can't be created or edited in the new editor."}}},{"type":"paragraph","content":[{"text":"To change the structure/nesting:","type":"text","marks":[{"type":"strong"}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"nestedContent":{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"section","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Section"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Start:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nvar source = {\n goat: false,\n sheep: [\n \"baaa\",\n \"wooooool\"\n ],\n ...\n}\n","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"\n","type":"text"},{"type":"hardBreak"},{"text":"\n","type":"text"},{"text":">>","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Rule to change the nesting:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nvar rules = {\n \"farm.goat\": { \n expander: {\n type: \"fluid.model.transform.value\",\n path: \"goat\"\n }\n },\n \"farm.sheep\": {\n expander: {\n type: \"fluid.model.transform.value\",\n path: \"sheep\"\n }\n } \n ....\n}\n","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"\n","type":"text"},{"type":"hardBreak"},{"text":"\n","type":"text"},{"text":">>","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Result:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n{\n farm: {\n goat: false,\n sheep: [\n \"baaa\",\n \"wooooool\"\n ]\n },\n ...\n}\n","type":"text"}]}]}]}],"version":1},"cxhtml":"

Start:

\njavascript

\n
\n>>

Rule to change the nesting:

\njavascript

\n
\n>>

Result:

\njavascript

","reason":"A section macro in a rich body macro can't be created or edited in the new editor."}}},{"type":"heading","attrs":{"level":4},"content":[{"text":"fluid.model.transform.arrayValue","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"arrayValue","type":"text","marks":[{"type":"code"}]},{"text":" expander will transform a value into an aray. If the value is already an array, the expander will have no effect.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example:","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"nestedContent":{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"section","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Section"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Start:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nvar source = {\n cat: \"meow\",\n sheep: [\n \"baaa\",\n \"wooooool\"\n ],\n ...\n}\n","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"\n","type":"text"},{"type":"hardBreak"},{"text":"\n","type":"text"},{"text":">>","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Rule to convert to arrays:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\nvar rules = {\n cat: { \n expander: {\n type: \"fluid.model.transform.arrayValue\",\n path: \"cat\"\n }\n },\n sheep: {\n expander: {\n type: \"fluid.model.transform.arrayValue\",\n path: \"sheep\"\n }\n } \n ....\n}\n","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"\n","type":"text"},{"type":"hardBreak"},{"text":"\n","type":"text"},{"text":">>","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Result:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n{\n cat: [\"meow\"],\n sheep: [\n \"baaa\",\n \"wooooool\"\n ],\n ...\n}\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that the value of ","type":"text"},{"text":"cat","type":"text","marks":[{"type":"code"}]},{"text":" is now an array, but the value of ","type":"text"},{"text":"sheep","type":"text","marks":[{"type":"code"}]},{"text":" is unaffected.","type":"text"}]}]}]}],"version":1},"cxhtml":"

Start:

\njavascript

\n
\n>>

Rule to convert to arrays:

\njavascript

\n
\n>>

Result:

\njavascript

Note that the value of cat is now an array, but the value of sheep is unaffected.

Parameters

Return Value

See Also

fluid.model.transformWithRules