Versions Compared

Key

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

...

The connection between WhatIfs-instances and workflows is (as off 2022.01) established via the IFD, the Interactive Forecasting Displays WorkflowDescriptors, where a <whatIfTemplateId> can be defined after the <workflowId> (one of the last elements).

Code Block
titleConnecting a whatif template to a workflow
	<workflowDescriptor id="Test_WhatIfSettings" name="Test_WhatIfSettings" forecast="true" visible="true" autoApprove="true">
		...
		<whatIfTemplateId>test_whatif</whatIfTemplateId>
	</workflowDescriptor>

Note: this is a non-backward compatible changed for 2021.02 and earlier applications whethe the connection betwen workflows and WhatIfTemplates was defined in the Topology.xml.

What-ifs are by default non-approved runs, unless the user puts a check in the approve checkbox of the GUI.

You can use the IFD-config option <enableAutoApprove> to bring the auto approve button to the attention of the user. This checkbox is however not shown when specifying a relative viewPeriod in the IFD-node.

Code Block
languagexml
titleConnecting a WhatIf-template to a workflow in the Topology.xml or TopologyGroup.xmlEnabling the auto-approve checkbox in the IFD
        <node id="run_whatif_properties" name="wf1 t1 Properties">
            <workflowId>Test_WhatIfSettings</workflowId>
			<enableAutoApprove>false</enableAutoApprove>
            <whatIfTemplateId>whatif_properties</whatIfTemplateId>....

The WhatIf Editor uses the whatifTemplates.xsd schema. This schema allows the configuration of a whatif-template, which is used in the WhatifEditor GUI to allows the specification of properties and modifiers to be applied in a whatif-instance. Multiple whatIfTemplate.xml files are supported as long as their prefix is WhatIfTemplates_....xml and no duplicate identifiers are used across the files. Identifiers defined in one xml-file can be used in another xml-file.

...