Skip to content
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.

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

Create an API to build and render reports #6284

Closed
DrewAPicture opened this issue Jan 8, 2018 · 5 comments
Closed

Create an API to build and render reports #6284

DrewAPicture opened this issue Jan 8, 2018 · 5 comments

Comments

@DrewAPicture
Copy link
Contributor

DrewAPicture commented Jan 8, 2018

PR Relies On Tracking Project
#6289, #6329 #6254, #6280 #6236 3DD™: Reporting API Reboot

Background

This primarily builds off of the work being done in #6254 and #6280. Once the report and endpoint registries are in place, we'll need to introduce an API for actually rendering the pieces stored in those registries.

The thinking is that, just as Endpoint objects are being built from Endpoint_Registry entries in #6280, the process of instantiating a report for display should work similarly.

More specifically, a call will go out for all registered reports to be instantiated as Report objects, with the view type for endpoints set by virtue of inclusion in specific view lists in the report registry entries. For example, if a report is registered with several endpoints under a tiles key, all of those endpoint records will be instantiated in the Report object with the view and data model logic in place for the tile view type.

It should be possible to both retrieve a registered report and instantiate one on the fly (as well as retrieve registered endpoints and/or create them on the fly). This approach allows for the greatest level of flexibility in extending the new reports API.

Ideally, at the time of instantiation, the Report object should contain all of the necessary information for display short of actually having performed the queries set out in the data model corresponding to the endpoint views. This allows for loading much of the endpoint data just-in-time (JIT).

@DrewAPicture
Copy link
Contributor Author

WIP PR: #6289

@DrewAPicture
Copy link
Contributor Author

Merged #6289. Moving forward now with rendering logic.

@DrewAPicture
Copy link
Contributor Author

Started a WIP PR for reports rendering logic: #6329

@DrewAPicture
Copy link
Contributor Author

Merged #6329. Leaving this open for more future changes.

@DrewAPicture
Copy link
Contributor Author

Actually, I'm going to close this in favor of new issues for anything new that comes up in the spirit of forward progress.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant