Defines a screen class entry handler.

A Handler is similar to a Function except that it is automatically executed when the associated event occurs. The Screen class entry handler is a handler associated with the entry on a screen class event. It is executed when Convertigo detects the screen class corresponding to this Screen class entry handler, before executing the extraction rules associated with this screen class.
In other words, a Screen class entry handler is executed when arriving on the screen class associated with this handler.
Notes:

• A Screen class entry handler contains other statements that define the actions to be performed on this screen class. It can return a result value (redetect by default as it is an entry handler).
• Screen class entry handlers can only be added to a transaction, one Screen class entry handler for each screen class per transaction.

Property Type Category Description
Comment String standard Describes the object comment to include in the documentation report.
This property generally contains an explanation about the object.
Infinite loop protection boolean standard Defines whether the handler should be protected against infinite loops in transaction.
If set to true (default value), the handler prevents infinite loops by throwing a Convertigo Engine exception when an infinite loop is detected.
Default value should not be changed unless you specifically want the handler to authorize loops in transaction.
Is active boolean standard Defines whether the statement is active.
Result String standard Defines the handler’s default resulting value.
Depending on the handler type, this property can be chosen among several available values.
For a Screen class entry handler, this property can take the following values:

• <empty> or "": goes on and extracts data using extraction rules,
• continue: similar to <empty> value,
• redetect: does not extract data and redetects a new screen class,
• skip: stops the transaction without extracting data.

Note: The Handler’s default return value defined thanks to this property can be overridden by a child Return statement.
Screen class String standard Defines the screen class to be monitored.
This property allows to associate the Screen class handler with the screen class on which it is executed. The possible values for this property are generated from the screen classes defined in the connector.
If the screen class is renamed in the connector, the Screen class property of associated Screen class handlers (entry or exit) are automatically updated.