Skip to content

Commit c21a8fd

Browse files
committed
update doc
1 parent cc75508 commit c21a8fd

2 files changed

Lines changed: 142 additions & 0 deletions

File tree

Lines changed: 125 additions & 0 deletions
Loading

src/features/2.metrics.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,8 @@ Each combination of data source and data type represents a different metric calc
145145

146146
## Workflow
147147

148+
![Metrics Report Workflow](./2.metrics-report-workflow.drawio.svg)
149+
148150
### Create metric
149151

150152
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.
@@ -155,10 +157,25 @@ On the experience dashboard, there will be a "metrics" tab. Admin can configure
155157

156158
`required` metric and `recommanded` metric will have special indicator to remind the admin to do the configuration. If they are not configured properly, when admin try to make the experience live, it will popup some warning message.
157159

160+
### Create report
161+
162+
After configuring metrics, admin can create a new report to organize and display the metric data. The report creation allows selecting which metrics to include and defining the report structure.
163+
164+
### Configure report
165+
166+
Once a report is created, admin can configure various aspects of the report including:
167+
- Report section name
168+
- Report type (circle number, card, table, pie chart, bar chart)
169+
- Visual presentation settings
170+
158171
### Trigger metric calculation
159172

160173
On MVP, we will only implement on demand calculation. There will be a button on the experience dashboard "metrics" tab to trigger the calculation
161174

175+
### View report results
176+
177+
After triggering the calculation, admin can view the report results in the configured format. The results will display the calculated metric values based on the selected report type and configuration settings.
178+
162179
### Export metric result report
163180

164181
There will be a button in the experience dashboard "metrics" tab to export the report CSV

0 commit comments

Comments
 (0)