Skip to content

Commit ee6bdad

Browse files
lushonlinelushonline
committed
Updated README
2 parents 16848e7 + ab25848 commit ee6bdad

File tree

1 file changed

+30
-24
lines changed

1 file changed

+30
-24
lines changed

‎README.md

+30-24
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
# External Content with Completion
2-
3-
![Moodle Plugin CI](https://github.com/lushonline/moodle-mod_externalcontent/workflows/Moodle%20Plugin%20CI/badge.svg?branch=experimental)
1+
# External Content with Completion #
2+
![Moodle Plugin CI](https://github.com/lushonline/moodle-mod_externalcontent/workflows/Moodle%20Plugin%20CI/badge.svg)
43

54
The module enables a teacher to create a resource using the text editor.
65

@@ -17,55 +16,62 @@ the completion can then be imported using [moodle-tool_uploadexternalcontentresu
1716
## Installation
1817

1918
---
20-
21-
1. Install the External content activity module experimental branch:
19+
1. Install the External content activity module:
2220

2321
```sh
24-
git clone --branch experimental https://github.com/lushonline/moodle-mod_externalcontent.git mod/externalcontent
22+
git clone https://github.com/lushonline/moodle-mod_externalcontent.git mod/externalcontent
2523
```
2624

27-
## Configuring xAPI Realtime Tracking (Experimental in v1.6-BETA)
25+
Or install via the Moodle plugin directory:
26+
27+
https://moodle.org/plugins/mod_externalcontent
2828

29-
The experimental xAPI Realtime Tracking implements basic LRS Statement API functionality.
29+
## Configuring xAPI Tracking
3030

31-
This allows an [Activity Provider (AP)](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-About.md#def-activity-provider) to send statements for External Content Activity items, that can be used to set the Moodle Viewed status and External Completed status for the item.
31+
The xAPI Tracking implements basic LRS Statement API functionality.
3232

33-
The received statements are not saved to Moodle, but parsed as received
33+
This allows an [Activity Provider (AP)](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-About.md#def-activity-provider) to send statements for External Content Activity items, that can be used to set the Moodle Viewed status, External Completed status and scores for the item.
3434

35-
The Statement [Object Id](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#acturi) is used to identify the course and External Content Activity Item, the Moodle [Course ID Number](https://docs.moodle.org/310/en/Course_settings#Course_ID_number) needs to be set to this value.
35+
The External Content Activity items need to be configured to be marked completed externally when created.
36+
37+
The xAPI statements are not saved to Moodle, but processed on receipt.
38+
39+
The Statement [Object Id](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#acturi) is used to identify the course and External Content Activity Item, the Moodle [Course ID Number](https://docs.moodle.org/310/en/Course_settings#Course_ID_number) and the External Content Activity Item ID Number needs to be set to this value.
3640

3741
The Statement [Actor Account Name](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#inversefunctional) is used to identify the Moodle User using their Moodle [Username](https://docs.moodle.org/310/en/Add_a_new_user#Username).
3842

39-
Any Statement [Verb Id](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#verb) received is used to set the Viewed status of the Activity. As Moodle does not support setting the timestamp for the Viewed event it will be the time that the statement was processed by the module.
43+
Any Statement [Verb Id](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#verb) received results in the Viewed status of the Activity been set. As Moodle does not support setting the timestamp for theses events it will be the time that the statement was processed by the module.
4044

4145
If the Statement [Verb Id](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#verb) is one of those configured to indicate completion (Defaults are: http://adlnet.gov/expapi/verbs/completed and http://adlnet.gov/expapi/verbs/passed) the Activity Item "Completed Externally" value is set to true.
4246

47+
If the Statement [Results](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#245-result) contains a score the score is stored.
48+
4349
### What has been implemented
4450

45-
| Resource | HTTP Methods | Comments |
46-
| ----------------------------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
51+
| Resource | HTTP Methods | Comments |
52+
| -------- | ------------ | --------- |
4753
| [Statements Resource](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Communication.md#stmtres) | GET, PUT, POST | This is WRITE ONLY and so supports POST, PUT only. GET requests return a "null" response so as to be "valid" but the functionality is not implemented. The JSON statements received are parsed using [TinCan PHP](https://github.com/RusticiSoftware/TinCanPHP), and used to set the viewed status, completion status and score for the content if available. |
48-
| [About Resource](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Communication.md#aboutresource) | GET | This returns tha xAPI version supported which for this is 1.0.0 |
54+
| [About Resource](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Communication.md#aboutresource) | GET | This returns tha xAPI version supported which for this is 1.0.0 |
4955

5056
<br>
5157

5258
### Setup Activity Settings
5359

54-
| Name | Setting | Description |
55-
| ----------------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
56-
| Enable xAPI LRS basic support | xapienable | Enable the basic xAPI support, if disabled all calls to the xAPI endpoint return a 401 Unauthorized status. The default is enabled. |
57-
| xAPI LRS Username | xapiusername | Configure the username which is used for basic authentication of the basic LRS endpoint. The default is a random string, setup when module is installed. |
58-
| xAPI LRS Password | xapipassword | Configure the password which is used for basic authentication of the basic LRS endpoint. The default is a random string, setup when module is installed. |
60+
| Name | Setting | Description |
61+
| ---- | ------- | ----------- |
62+
| Enable xAPI LRS basic support | xapienable | Enable the basic xAPI support, if disabled all calls to the xAPI endpoint return a 401 Unauthorized status. The default is enabled. |
63+
| xAPI LRS Username | xapiusername | Configure the username which is used for basic authentication of the basic LRS endpoint. The default is a random string, setup when module is installed. |
64+
| xAPI LRS Password | xapipassword | Configure the password which is used for basic authentication of the basic LRS endpoint. The default is a random string, setup when module is installed. |
5965
| List of completion xAPI verbs | xapicompletionverbs | Set the xAPI verbs that will be used to indicate the content has been "completed", if a verb that matches one of these values is received the completed externally flag is updated. Any other verb simply sets the viewed flag. The defaults are http://adlnet.gov/expapi/verbs/completed and http://adlnet.gov/expapi/verbs/passed |
6066

6167
<br>
6268

6369
### Setup Activity Provider
6470

65-
| Setup | Description |
66-
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
67-
| LRS Endpoint | In your activity provider you need to configure the path to this modules LRS endpoint. This will be https://{moodlehostname}/mod/externalcontent/lrs/index.php |
68-
| Authentication | The modules LRS only supports Basic Authentication and so you will need to use the username/password you configured above. |
71+
| Setup | Description |
72+
| ----- | ----------- |
73+
| LRS Endpoint | In your activity provider you need to configure the path to this modules LRS endpoint. This will be https://{moodlehostname}/mod/externalcontent/lrs/index.php |
74+
| Authentication | The modules LRS only supports Basic Authentication and so you will need to use the username/password you configured above. |
6975

7076
## License
7177

0 commit comments

Comments
 (0)