Skip to content

Commit

Permalink
crib cliffs tooltip for identity path doc
Browse files Browse the repository at this point in the history
  • Loading branch information
milt committed Jan 19, 2024
1 parent cf2ee9f commit ad895b2
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions doc/reactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Reactions allow SQL LRS to watch for patterns in submitted xAPI data and dynamic

To use Reactions the `LRSQL_ENABLE_REACTIONS` environment variable or the `enableReactions` LRS configuration property must be set to `true`. Reactions are disabled by default.

Reactions are defined in JSON:
Reaction "rulesets" are defined in JSON:

``` json

Expand All @@ -17,6 +17,24 @@ Reactions are defined in JSON:
[
"actor",
"mbox"
],
[
"actor",
"mbox_sha1sum"
],
[
"actor",
"openid"
],
[
"actor",
"account",
"homePage"
],
[
"actor",
"account",
"name"
]
],
"conditions": {
Expand Down Expand Up @@ -114,7 +132,9 @@ Reactions are defined in JSON:

### Identity Paths

`identityPaths` is an array of zero or more paths that must match across all statements in the sequence. These could include an actor identifier or statement registration.
Identity Paths (`identityPaths` in the ruleset JSON) are a method of grouping statements for which you are attempting to match conditions. Typically, Reactions may revolve around actor Inverse Functional Identifiers (IFIs), e.g. `["actor", "mbox"]` or `["actor", "account", "name"]` which is equivalent to saying "For a given Actor, look for statements that share IFI values".

Alternative approaches to Identity Path may be used by modifying `identityPaths`, for instance `["context", "registration"]` to group statements by learning session.

### Conditions

Expand Down

0 comments on commit ad895b2

Please sign in to comment.