ISISComputingGroup / ISISComputingGroup/DataStreaming

`filewriter`: journals

Open
#86 0 comments 0 reactions 0 assignees View on GitHub
filewriter
Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

The file-writing infrastructure must be able to write entries into the instrument `journal.xml` (and into the instrument journal MySQL database, `journal_` MS teams channels, and various other 'journal' workflows)

This is intentionally phrased as

> file-writing infrastructure

as this may not belong in the filewriter itself, but in a separate cooperating process.

See also https://github.com/ISISComputingGroup/DataStreaming/issues/11

## Potential differences from existing files

Not all fields in the current `journal.xml` make sense in the streaming system, for example:
- `icp_version`; this could be populated with a filewriter version instead.
- `detector_table_file` does not exist in the streaming system. Suggest populating this entry with `UNSPECIFIED` or similar.
- `spectra_table_file` / `wiring_table_file` do not have the same meanings/formats/locations in the streaming system. Programs which expect to be able to read a specific format from the filepaths in these entries will fail.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the related DataStreaming issue 11 and the existing instrument journal.xml structure. Compare its fields with the streaming system, especially icp_version, detector_table_file, spectra_table_file, and wiring_table_file. Done requires an agreed design for writing journals to XML, the journal_ MySQL database, MS Teams channels, and other journal workflows.

Written by the indexing model from the issue text.

Assessment

Tech stack
mysql
Domain
backend, databases
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.