Functions - Validate and Control User Input

These are functions that Enterprise Architect calls to validate and control user input. For each function a set of objects is filled.

Function

Action

Return Value

AllowPhaseUpdate(OldValue, NewValue)

Validate a change a user has made to a phase

  • True to allow this user to make this change
  • False to disallow the change and revert to the previous value

AllowStatusUpdate(OldValue, NewValue)

Validate a change a user has made to a status

AllowTagUpdate(TagName, OldValue, NewValue)

Validate a change a user has made to a Tagged Value

AllowVersionUpdate(OldValue, NewValue)

Validate a change a user has made to a version

CanEditPhase()

Enable or disable the control for editing a phase

  • True to allow this user to make changes by enabling the control
  • False to completely disable edit of this property by disabling the control

CanEditStatus()

Enable or disable the control for editing a status

CanEditTag(TagName)

Enable or disable the control for editing a Tagged Value

CanEditVersion()

Enable or disable the control for editing a version

PreAllowPhaseUpdate(OldValue, NewValue)

 

Determine what information is required to validate this change

Semi-colon separated list of additional data required in order to validate this change

Supported Data Type:

Tests - fill the Tests array in the WorkflowContext object

PreAllowStatusUpdate(OldValue, NewValue)

PreAllowTagUpdate(TagName, OldValue, NewValue)

PreAllowVersionUpdate(OldValue, NewValue)

Learn More: