Versions Compared

Key

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

...

whatIfExpiryTime (since 2022.01)

The expiry time of whatIf is the amount of time that the what-if scenario (created with the WhatIfEditor) remains in the Topology menu. The default expiry time of the whatIf can be overruled with the a custom expiry time configured in whatIfTemplate with the element ‘whatIfExpiryTime’. This custom expiry time will be used also for the modifiers associated with the whatIf’s created using the whatIfTemplate. If no whatIfExpiry time whatIfExpiryTime is specified, ... [What is the default expiry time of the whatif?]for the workflow will be used instead.

properties

This is a list of all properties that are shown in the WhatIfEditor display, either as text field or drop-down menu (dependending on the valueType), that need to be defined in each instance of the what-if scenario.

...

This makes it possible to nest whatIfTemplate sections within one another, to allow for some structure in the WhatIfEditor display.

Final notes

  1. WhatIfTemplateIds WhatIfTemplates are stored as part of the whatif-instance, also when archived. Changing a whatIfTemplate (while maintaining the same whatIfTemplateId) may thus break retrieval of archived whatif scenarios (i.e. no similar as other archive exchanges <WHAT?>)
  2. The relation between modifiers and whatif scenarios is stored at the modifier side. Exported whatif scenarios are unaware of associated modifiers, although the exported zip-file will include both the whatif.xml and the modifiers.xml if needed.
  3. As of 2022.01, a TypicalProfile modifier was introduced to enable full replacement of the legacy whatif-functionality.
  4. This configuration example includes several examples of how to configure and use properties and modifiers in whatifs scenarios.

...