tazama-lf / frms-coe-startup-lib

frms-coe-startup-lib
Apache License 2.0
2 stars 0 forks source link

FRMS-coe-startup-lib: Consolidate configuration files into the configuration database #34

Closed Sandy-at-Tazama closed 3 months ago

Sandy-at-Tazama commented 5 months ago

User Story

As a Tazama system operator I want to align the names of the different collections and consolidate all configuration collections into the same database so that there is improved maintainability; and so that there are consistent development practices; and so that the system is as simple as possible to maintain and configure for an inexperienced user

Background

epic: consolidate configuration files into the Configuration database #10

Database layout and contents in Tazama is inconsistent and out of date:

The Configuration database contains the following collections:

The networkmap database contains the following collection:

The change

  1. Remove the channelExpression collection (Dependent on the removal of the CADProc from the default Tazama flow)
  2. Rename the "configuration" collection to the "ruleConfiguration" collection a. Move rule configuration retrieval to the Tazama code library b. Update rule processors to retrieve their configurations from the renamed collection by implementing the code from the Tazama code library
  3. Rename the "typologyExpression" collection to the "typologyConfiguration" collection. a. Move typology configuration retrieval to the Tazama code library b. Update the typology processor to retrieve its configuration from the renamed collection by implementing the code from the Tazama code library
  4. Remove the "transactionConfiguration" collection.
  5. Move the "networkConfiguration" from the networkmap database to the Configuration database a. Move ED configuration retrieval to the Tazama code library b. Update the ED to retrieve its configuration from the renamed collection by implementing the code from the Tazama code library

Acceptance Criteria

  1. Implement a version bump
  2. Rename the "configuration" collection to the "ruleConfiguration" collection - Move rule configuration retrieval to the Tazama
  3. Rename the "typologyExpression" collection to the "typologyConfiguration" collection - Move typology configuration retrieval to the Tazama code librarycode library
  4. Move the "networkConfiguration" from the networkmap database to the Configuration database -Move EDconfiguration retrieval to the Tazama code library
  5. Tests via integration testing
  6. Create/Update the documentation
rtkay123 commented 3 months ago

This shouldn't need changes as this library handles IPC, which is not affected

Justus-at-Tazama commented 3 months ago

image