Skip to content

Commit

Permalink
docs: update readme attributions
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewhilton committed Nov 14, 2022
1 parent 598a4f3 commit 1d30817
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 11 deletions.
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,22 @@

![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/catalyst/moodle-tool_dataflows/ci/MOODLE_35_STABLE)

* [What is this?](#what-is-this)
* [Branches](#branches)
* [Alternatives](#alternatives)
* [Installation](#installation)
* [Configuration](#configuration)
* [Guides](#guides)
* [Support](#support)
* [Warm thanks](#warm-thanks)
- [moodle-tool_dataflows](#moodle-tool_dataflows)
- [What is this?](#what-is-this)
- [Branches](#branches)
- [Alternatives](#alternatives)
- [tool_etl](#tool_etl)
- [tool_trigger](#tool_trigger)
- [local_webhooks](#local_webhooks)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [Configuration](#configuration)
- [Best practices for workflows](#best-practices-for-workflows)
- [Guides](#guides)
- [Support](#support)
- [Warm thanks](#warm-thanks)
- [University College London](#university-college-london)
- [NSW Department of Education](#nsw-department-of-education)

## What is this?

Expand Down Expand Up @@ -88,11 +96,16 @@ sponsor a new feature then please contact

## Warm thanks

Thanks to various orgnisations for support in developing this plugin:
Thanks to various organisations for support in developing this plugin:

### University College London
![image](https://user-images.githubusercontent.com/187449/180128782-474fcdab-62c5-4848-ab6b-92ff4ece5d6f.png)

### NSW Department of Education
For sponsoring the development of the event trigger functionality.


![NSW DET](https://user-images.githubusercontent.com/17095477/201774199-aa1d2ce9-eccf-4aca-ab69-2fef75971ae1.png)

This plugin was developed by [Catalyst IT Australia](https://www.catalyst-au.net/).

Expand Down
4 changes: 2 additions & 2 deletions VARIABLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ public function execute($input = null) {
```
We then create a dataflow and configure the step called `course_viewed` with the following `Variables` config:

![image](./pix/expose_variables.png)
![image](https://user-images.githubusercontent.com/17095477/201774207-c478076f-c43c-4781-ad52-2d20ced6a356.png)

Then in a later step, we can access it either from the `{{steps.course_viewed.event.courseid}}` or `{{steps.course_viewed.vars.courseid}}`

![image](./pix/variable_tree.png)
![image](https://user-images.githubusercontent.com/17095477/201774176-5c347567-2362-4397-aebe-00924ea0b6dc.png)

This is because when we specify `courseid: ${{ event.courseid }}`, the dataflows engine then assumes that a variable `event` is exposed with the property `courseid` from that step, because we have told it so in the `course_viewed` step definition.
Binary file removed pix/expose_variables.png
Binary file not shown.
Binary file removed pix/variable_tree.png
Binary file not shown.

0 comments on commit 1d30817

Please sign in to comment.