API concept

Flow

Use Case dependent

Make use of the API functions having on mind the following order:

• UxBeginUseCase(0, "Button O");
  • UxBeginAction(0, "Button X");
    • UxBeginStep(0, 0, "Button Y");
    • UxCompleteStep(0, 0, "Button A");
    • UxBeginStep(0, 1, "Button B");
    • UxCompleteStep(0 , 1, "Button L1");
    • ...
  • UxCompleteAction(0, "Button L2");
  • UxBeginAction(1, "Button R1");
    • UxBeginStep(1, 0, "Button R2");
    • UxCompleteStep(1, 0, "Button L3");
  • UxCompleteAction(1, Button R3");
  • ...
• UxCompleteUseCase(0, "Button O");

Algorithm

The algorithm of the tool will strictly follow the order presented above. A step can be started only if the previous step has been completed; an action can be completed, if all of its content steps have been completed. In the same way, a use case is considered as completed, if all actions have been executed. Only then the tool will generate a CSV file that will be exported. The UxSetInteraction() function can be used at any point of this order.

The reason for this approach is to keep the integrity of the results of the usability tests with respect to the use cases that will be provided as a measuring basis.

Template file

Open the UseCaseData.json file that contains the use case related information structured hierarchically.

• In the example, in order to keep it simple, we have actually a single use case with two actions.
• The number of use cases, actions and steps can be edited according to the needs of the usability testing.
• The use case has an ID and a title that can be edited.
• The action have also an ID, a title and a description that can be edited.
• Each action contains further steps. Tehse steps have also an ID, a title and a description that can be edited.