Saved Custom Report Templates #15714
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
can the save templates be used to automate weekly reports? |
|
@mcarasso-PPD not in this first version of the feature but it's something we're exploring for a future release. |
marcusmoore
commented
Nov 8, 2024
Comment on lines
+48
to
+84
| static::created(function (ReportTemplate $reportTemplate) { | ||
| $logAction = new Actionlog([ | ||
| 'item_type' => ReportTemplate::class, | ||
| 'item_id' => $reportTemplate->id, | ||
| 'created_by' => auth()->id(), | ||
| ]); | ||
|
|
||
| $logAction->logaction('create'); | ||
| }); | ||
|
|
||
| static::updated(function (ReportTemplate $reportTemplate) { | ||
| $changed = []; | ||
|
|
||
| foreach ($reportTemplate->getDirty() as $key => $value) { | ||
| $changed[$key] = [ | ||
| 'old' => $reportTemplate->getOriginal($key), | ||
| 'new' => $reportTemplate->getAttribute($key), | ||
| ]; | ||
| } | ||
|
|
||
| $logAction = new Actionlog(); | ||
| $logAction->item_type = ReportTemplate::class; | ||
| $logAction->item_id = $reportTemplate->id; | ||
| $logAction->created_by = auth()->id(); | ||
| $logAction->log_meta = json_encode($changed); | ||
| $logAction->logaction('update'); | ||
| }); | ||
|
|
||
| static::deleted(function (ReportTemplate $reportTemplate) { | ||
| $logAction = new Actionlog([ | ||
| 'item_type' => ReportTemplate::class, | ||
| 'item_id' => $reportTemplate->id, | ||
| 'created_by' => auth()->id(), | ||
| ]); | ||
|
|
||
| $logAction->logaction('delete'); | ||
| }); |
There was a problem hiding this comment.
Understandable if we want to move these to an observer.
|
@snipe friendly ping on this PR. I know it's a lot of changes but it is mostly additions for the new feature so hopefully it is easier to review. |
snipe
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces the concept of Saved Custom Asset Report Templates so users that frequently run Custom Asset Reports can load a customized pre-defined template instead of having to select all of the options they want each time.
Overview of Feature
New Custom Asset Report page with new options to open saved template or created a new one with the selected options
So if you select some options, enter a name and hit save
You'll be redirected to the saved template and can hit
Generatelike normal at the bottom of the pageYou can select existing saved templates upon returning the Custom Asset Report page in the future from the menu on the top left of the page
Templates can be updated by clicking the yellow pencil icon, updating selections, and hitting the Save button at the bottom of the page
Templates can also be (soft) deleted by clicking the red trash icon
Technical Details / Decisions
Here are some decisions that were made in this PR that we might want to change before merging:
ReportTemplatebooted()method.ReportTemplatemodel's name field does not have a unique constraint on it. This will make it easier to handle any duplicate names issues when reports are eventually sharable.reports.viewpermission was re-used for managing saved templates.ReportTemplate) was used to simplify changes to the view (avoid adding a bunch ofifchecks to see if the user is working with a saved template or generating a report on the fly). This is seen in the modifications to the existingReportsController.(Potential) Future Improvements
Big shoutout to @akemidx for kicking this off and pairing throughout!
Fixes #4616
Type of change