You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/features/2.metrics.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,12 @@ Metric is used to allow admin configuring custom metrics for an assessment to se
7
7
### `analytics_metrics`
8
8
9
9
*`id` id of this metric
10
+
*`uuid` uuid of this metric
10
11
*`name` the name of this metric
11
12
*`description` the description of this metric
12
13
*`is_public` whether this is a public metrics in the metrics library
13
14
*`data_source` : which data source we are linking to for the calculation
14
-
* For MVP, we only support `assessment question`
15
+
* For MVP, we only support `question`
15
16
*`data_type` defines how to link to an assessment question. It has the following valid value (MVP):
16
17
*`scalar` : can only be linked to a radio button choice question of an assessment
17
18
*`aggregation` defines how to calculate the result. It has the following valid value: (when the `data_type` is `scalar`)
@@ -36,9 +37,9 @@ Relationship between a metric and an institution
36
37
*`recommanded` : an experience can go live without linking this metric to an assessment, but there will be a warning
37
38
*`not required` : an experience can go live without linking this metric to an assessment
38
39
*`status`
39
-
*`draft` : won't show on the experience page
40
-
*`active` : show on the experience page
41
-
*`archived` : won't show on the experience page
40
+
*`inactive` : when this metric is not linked to any assessment question in any experience
41
+
*`active` : when the metric is linked to an assessment question in an experience
42
+
*`archived` : the metric won't be calculated anymore
42
43
43
44
### `analytics_metric_links`
44
45
@@ -47,7 +48,7 @@ Relationship between a metric and a data source link in an experience
47
48
*`id`
48
49
*`metric_id`
49
50
*`data_source_id` : the related data source id
50
-
* When `data_source` = `assessment question`, this id is the question id
51
+
* When `data_source` = `question`, this id is the question id
51
52
*`experience_id`
52
53
*`institution_id`
53
54
*`calculation_frequency` : when to calculate the metrics
@@ -67,9 +68,9 @@ The table to store the metric report records
67
68
68
69
### Create metric
69
70
70
-
There will be a page on the institution level to see all the required/recommanded metric and institution admin is able to create new metric or use a metric from the metric library.
71
+
There will be a page on the institution level to see all the metrics in the institution and institution admin is able to create new metric or use a metric from the metric library.
71
72
72
-
### Use metric
73
+
### Configure metric
73
74
74
75
On the experience dashboard, there will be a "metrics" tab. Admin can configure the metric (i.e. link metric to a specific assessment question).
0 commit comments