Skip to content

Documentation Roadmap

Jump to bottom
Steve Ives edited this page Jun 15, 2020 · 6 revisions

Harmony Core Logo

Documentation Roadmap

We have many improvements planned for the Harmony Core documentation, and we will continue to provide information about Harmony Core in other formats and forums. We plan to update existing wiki content, fill in gaps in the information presented in the wiki, add documentation for new features, publish case studies, and continue authoring blog posts. The following sections in this document go into greater detail about these changes:

New Wiki Content

We plan to add the following topics to fill in gaps in the information provided by the Harmony Core documentation wiki. Some other topics we plan to add are listed in Updates for Issues on GitHub below.

Tutorial topics:

  • Calling a Harmony Core (OData) web service from Synergy code using HttpClient or the Synergy HTTP API
  • Standalone use of EF Core, with an example that shows what happens when a transaction fails
  • Custom file I/O examples (perhaps with information on custom file name mapping)

Reference and procedure topics:

  • Changing generated code
  • Versioning with NuGet
  • Understanding long description codes for Repository, including a list of all the codes, what they do, and where you should use them (e.g., SAMPLE_DATA, HARMONY_ROLES, HARMONY_AUTHENTICATE)
  • Isolating code from other instances of the same code
  • Optimistic concurrency
  • API versions

"Deep dives" (topics that go beyond basic Harmony Core development tasks):

  • Flow of translation from Entity Framework Core to PreparedQuery
  • Execution of prepared query and materialization of returned data objects
  • AssemblyLoadContext isolation (where DLLs are loaded, restrictions, etc.)
  • Relations and multi-segment keys and how Entity Framework Core ties it all together
  • OData EDM model construction and routing

We also plan to add Harmony Core class and interface documentation.

Updates for Issues on GitHub

We plan to update the documentation wiki for the following GitHub Issues:

  • Issue #139 – Add information on integrating Synergy DBL code formerly used with xfServerPlus.
  • Issue #130 – Provide guidance for validating data relationships when using PUT, PATCH, and POST operations.
  • Issue #62 – Provide guidance for setting up relations for data with tag fields.
  • Issue #18 – Provide documentation and a sample project for a web service secured with WS-Federation.
  • Issue #9 – Add a “quick start” topic for replacing underlying file I/O routines with custom routines.
  • Issue #6 – Provide an example of a client generated with Swagger.

Harmony Core Blog Posts and Case Studies

We will continue adding blog posts (which include posts with Office Hours videos) to our Harmony Core Blog, and we plan to publish two case studies in the first quarter of 2020.

Clone this wiki locally