getVisualizationData

A Workflow Engine function that retrieves the Visualize data, including cookbook and recipe details, for a situation. The function stores the details in the workflowContext, under workflowContext.visualize, which subsequent actions can then utilize.

This function is available as a feature of the Workflow Engine v1.1 download and later.

This function is available for Situation workflows only.

Back to Workflow Engine Functions Reference.Workflow Engine Functions Reference

Arguments

Workflow Engine function getVisualizationData has no arguments.

Example

The following example demonstrates typical use of Workflow Engine function getVisualizationData. Creating a Situation using the "Description" recipe in the "Default Cookbook" produces the following result set:

{
    "visualise": {
        "origin": "Cookbook",
        "cookbook_name": "Default Cookbook",
        "recipe_name": "Description"
    }
}