Modification of Result Collection using SequenceFilePostResultListEntry Callback

This example illustrates how you can control result collection in TestStand using the SequenceFilePostResultListEntry Engine callback. When you override the SequenceFilePostResultListEntry callback, the callback is called after each Step's result has been added to the ResultList. Like most callbacks, SequenceFilePostResultListEntry passes several useful parameters: the step (Parameters.Step), the step's result (Parameters.Result), and a Boolean variable (Parameters.DiscardResult). If you set Parameters.DiscardResult to True inside this callback, then that result is discarded from the ResultList and does not appear in the report.

The sequence file attached below demonstrates this approach by discarding all results except those for steps that have failed. This is especially useful for XML reports (since in the Report Options dialog box the Result Filtering option is disabled when the XML Document report format is selected), but will also work for text and HTML report formats as well.

Note: With this approach, you should leave the Step failure causes sequence failure checkbox enabled for any step that might fail. This checkbox is in the Step Properties dialog box on the Run Options tab, and is enabled by default. If this checkbox is disbaled, Sequence Call steps will not be marked as Failed when one when of its steps fails, so the sequence call's result (and all the step results it contains) will be discarded and the report will not display the correct information.

Related Links:

KnowledgeBase 2FTCHAY6: Runtime Manipulation of the ResultList Contents

KnowledgeBase 3D3AAI0U: How Do I Filter Results in a TestStand XML Report?

Requirements

Filename: discardresult.seq

Software Requirements

Application Software: NI TestStand Development System 3.0
Language(s): None

Reader Comments | Submit a comment »