How Do I Determine the Interval Being Used by the Engine to Poll Async Events? (Magic xpa 3.x)

When a batch task is running, the Magic xpa engine does not wait for input, it just processes records as fast as the system allows. It can poll for pending events though, and respond to those events when they happen. How often it checks for events depends on three settings:

1. Task Properties->Behavior->Allow Events: If this is Yes or evaluates to TRUE, then the engine checks for events. Otherwise, it does not. An “event” includes pressing the keys, so if this is set to No then the user cannot cancel the batch task by pressing the ESC key.

2. Options->Environment->System->Batch Interval: This affects all batch tasks in the application, but you can change it at runtime using INIPut, if you need to.

   • Zero: Never poll based on time interval.

   • N: Poll every N milliseconds.
     

3. Task Properties->Behavior->Record Event Interval: This setting only effects the current task, and tells the engine to check for events based on numbers of records processed. You can set it to Yes or No, or use an expression to set it at runtime.

   • Zero: Never poll based on number of records

   • N: Poll every N records.

These settings work together. For instance:

• If Allow Events is set to No, there will be no polling for events, regardless of the other settings.

• If Batch Interval is 0 and Record Event Interval is 0, there will be no polling for events regardless of the Allow Events setting.

• If the Batch Interval is 300 and the Record Event Interval is 20, then the engine will poll for events every 300 milliseconds and every 20 records.