From 344997f2e01ab3c8accaf80a2b3e9be9857266f1 Mon Sep 17 00:00:00 2001 From: kelvinqian00 Date: Fri, 4 Oct 2024 11:33:48 -0400 Subject: [PATCH] Connect the reactions and dev docs --- doc/dev.md | 2 +- doc/reactions.md | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/dev.md b/doc/dev.md index 3bf663f0..f56fa20d 100644 --- a/doc/dev.md +++ b/doc/dev.md @@ -121,7 +121,7 @@ Sample insert and query inputs can be found in the distribution at `bench/` Reactions are internally stored in SQL LRS as JSON object. Each reaction contains an `id`, `title`, `active`, `created`, `modified`, and `ruleset` property. Each `ruleset` is a JSON object that in turn contains the properties `conditions`, `template`, and `identityPaths`. -The following is an example reaction JSON object: +The following is the example reaction from [the tutorial](reactions.md), in JSON format: ```json { "id": "019257f4-d533-8c0b-8730-28b82f383982", diff --git a/doc/reactions.md b/doc/reactions.md index 0713dc86..e66e8afc 100644 --- a/doc/reactions.md +++ b/doc/reactions.md @@ -8,7 +8,6 @@ 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 table](images/reactions/table.png) To view a reaction, click on the reaction in the table above. This will display a reaction view page. @@ -137,4 +136,8 @@ Then the following statement will be added subsequently (note that some unrelate } ``` +### JSON Format + +Reactions are stored internally in JSON format. For an example, see the [developer documentation](dev.md#reaction-json). + [<- Back to Index](index.md)