Skip to content

[docs] Correct OBSERVATION_TIME field in ksql_observations readme #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keyvaann merged 1 commit into from
Jul 12, 2024
Merged

[docs] Correct OBSERVATION_TIME field in ksql_observations readme #295

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions docs/ksql-server_for_data-dashboard-backend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,23 @@ files should transform towards the following format of the _ksql_observations_ t
TOPIC: the topic identifier
CATEGORY: the category identifier (optional)
VARIABLE: the variable identifier
DATE: the date of the observation
END_DATE: the end date of the observation (optional)
OBSERVATION_TIME: datetime of the observation
OBSERVATION_TIME_END: the end datetime of the observation (optional)
TYPE: the type of the observation (STRING, STRING_JSON, INTEGER, DOUBLE)
VALUE_TEXTUAL: the textual value of the observation (optional, must be set when VALUE_NUMERIC is NULL)
VALUE_NUMERIC: the numeric value of the observation (optional, must be set when VALUE_TEXTUAL is NULL)
```

## Conventions

The mapping of topic fields is straightforward. The CATEGORY and VARIABLE fields are flexible that map to:

| Topic | CATEGORY | VARIABLE | VALUE |
|-------------------------|-------------------------------------------------|-------------------------------------------|--------------------|
| questionnaire_reponse | questionnaire name (e.g., _follow_up_a.1.0.3_) | questionId (e.g, _blwbg_lt2w_nervous_) | answer to question |
| questionnaire_app_event | questionnaire name (e.g., _follow_up_a.1.0.3_) | eventType (e.g., _QUESTIONNAIRE_STARTED_) | event metadata |


New messages are added to the _ksql_observations_ topic by inserting into the _observations_ stream (
see [_base_observations_stream.sql](_base_observations_stream.sql)):

Expand Down