oat-sa/extension-tao-outcomeui

extension to display the outcomes

Installs: 82 459

Dependents: 10

Suggesters: 0

Security: 0

Stars: 4

Watchers: 50

Forks: 4

Type:tao-extension

v12.3.1 2024-05-30 09:35 UTC

This package is auto-updated.

Last update: 2024-06-05 14:25:17 UTC


README

TAO Logo

GitHub GitHub release GitHub commit activity codecov

Extension implements resultServer interface to store results using ontology/statements table

Installation instructions

These instructions assume that you have already a TAO installation on your system. If you don't, go to package/tao and follow the installation instructions.

If you installed your TAO instance through package/tao, oat-sa/extension-tao-outcomeui is very likely already installed. You can verify this under Settings -> Extension manager, where it would appear on the left hand side as taoOutcomeUi. Alternatively you would find it in the code at /config/generis/installation.conf.php.

Note, that you have to be logged in as System Administrator to do this.

Add the extension to your TAO composer and to the autoloader:

composer require oat-sa/extension-tao-outcomeui

Install the extension on the CLI from the project root:

Linux:

sudo php tao/scripts/installExtension oat-sa/extension-tao-outcomeui

Windows:

php tao\scripts\installExtension oat-sa/extension-tao-outcomeui

As a system administrator you also install it through the TAO Extension Manager:

  • Settings (the gears on the right hand side of the menu) -> Extension manager
  • Select taoOutcomeUi on the right hand side, check the box and hit install

Configuration options

resultService.conf.php

Configuration option class

Description : contains the class name of a delivery results service.

Possible values of the class key:

  • an instance of any class that implements the ServiceLocatorAwareInterface interface.

Configuration option resultColumnsChunkSize

Description : contains a chunk size value.

Possible values of the resultColumnsChunkSize key:

  • a preset integer value of 20

resultViewer.conf.php

Configuration option deleteDeliveryExecutionDataServices

Description: an instance of any class that implements the ServiceLocatorAwareInterface interface.

Possible values:

  • a ResultsViewerService model.

Item results strategy

Provided new class oat\taoOutcomeUi\model\ItemResultStrategy to control exporting of results. Configuration provided by environments variable

export ITEM_RESULT_STRATEGY=item_instance_label

Support 4 type of configuration:

  • item_entity - legacy behavior all item variables collected for export as single item (even if item used in test more than 1 time). Labels for columns provided by combination of item label and variable context
  • item_instance_label - all item variables collected for export considering assessmentItemRef (data will be exported for every single item instance used in test). Labels for columns provided by combination item label and variable context
  • item_instance_item_ref - all item variables collected for export considering assessmentItemRef (data will be exported for every single item instance used in test). Labels for columns provided by combination of assessmentItemRef value and variable context
  • item_instance_label_item_ref - all item variables collected for export considering assessmentItemRef (data will be exported for every single item instance used in test). Labels for columns provided by combination of assessmentItemRef value, item label and variable context

if environment variable not provided default value will be considered as item_instance_label_item_ref

Registering default (phpfile) result page cache

 $ sudo -u www-data php index.php '\oat\taoOutcomeUi\scripts\tools\RegisterDefaultResultCache'

Delete result cache for a delivery execution aka. result

 $ sudo -u www-data php index.php 'oat\taoOutcomeUi\scripts\tools\DeleteResultCache' -u {deliveryExecutionUri}

Extension Wiki

You can find the extension wiki here.