https://github.com/oat-sa/extension-tao-outcomeui
Tao Outcome Visualisation
https://github.com/oat-sa/extension-tao-outcomeui
Last synced: 6 months ago
JSON representation
Tao Outcome Visualisation
- Host: GitHub
- URL: https://github.com/oat-sa/extension-tao-outcomeui
- Owner: oat-sa
- License: gpl-2.0
- Created: 2014-10-27T13:18:01.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-22T13:43:35.000Z (7 months ago)
- Last Synced: 2024-11-09T18:25:48.958Z (7 months ago)
- Language: PHP
- Size: 5.34 MB
- Stars: 4
- Watchers: 49
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TAO _taoOutcomeUi_ extension
[](https://codecov.io/gh/oat-sa/extension-tao-outcomeui)
> 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](https://github.com/oat-sa/package-tao) and follow the installation instructions.
If you installed your TAO instance through [package/tao](https://github.com/oat-sa/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:
```bash
composer require oat-sa/extension-tao-outcomeui
```
Install the extension on the CLI from the project root:
**Linux:**
```bash
sudo php tao/scripts/installExtension oat-sa/extension-tao-outcomeui
```
**Windows:**
```bash
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
```bash
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
```bash
$ sudo -u www-data php index.php '\oat\taoOutcomeUi\scripts\tools\RegisterDefaultResultCache'
```
### Delete result cache for a delivery execution aka. result
```bash
$ sudo -u www-data php index.php 'oat\taoOutcomeUi\scripts\tools\DeleteResultCache' -u {deliveryExecutionUri}
```
## Extension Wiki
You can find the [extension wiki here](https://github.com/oat-sa/extension-tao-outcomeui/wiki).