[SIP-163] Archiving Dashboards

[ethan-l-geotab]

Please make sure you are familiar with the SIP process documented
here. The SIP will be numbered by a committer upon acceptance.

[SIP] Proposal for Archiving Dashboards

Motivation

Dashboards have 2 states published and draft. However, there is state in which a dashboard my be deprecated and no longer needed, but required to be kept around for some time whether as a reference or any other reason. The archive status allows for these dashboard assets to be kept around for a while longer and not clutter up the dashboard lists of the owner (hidden) until searched for using the archived status filter.

Proposed Change

I added a new state for dashboards. Archived. This will make it so that it will not appear in the list of dashboard, unless it's set as Archived.

Archived Dashboard

Unarchived Dashboard

Dashboard List

New or Changed Public Interfaces

1. Added archive to dashboard model
2. Added button to archive dashboard
3. Added archive label to put in place of publish/draft labels for archived dashboards
4. Going from published to archived will unpublish it and put it back to draft.
   4.5 Unarchiving it will make it remain in draft
5. Archived dashboards will not be seen on the dashboard list without the Archived status filter
6. Enabling the archive status filter will allow users to see all archived dashboards

Migration Plan and Compatibility

Needs to add a new column to the dashboards. "archived"
Default value will be false. Can fully remove the column to downgrade

Rejected Alternatives

Describe alternative approaches that were considered and rejected.

[betodealmeida]

Needs to add a new column to the dashboards. "archived"

I assume we have a Boolean column for draft today? (Sorry, on my phone and away from computer) It might be better to convert that column to a string, a pseudo-enum with options "draft", "published", "archived". See https://maximilianocontieri.com/code-smell-07-boolean-variables for context of why.

[betodealmeida]

Also, this is a great feature!

[mattitoo]

This is a great feature - one thing to (maybe) keep in mind: The dashboard list gets really slow when there are a lot of dashboards. Archiving the dashboards should also make the search quicker. I am not technical enough to say how this should be achieved, but this is something to consider.
I was also thinking if it makes sense to be able to archive charts, but I believe the complexity increases in that case. Or maybe this should also be thought of?

[JZ6]

This is a great feature - one thing to (maybe) keep in mind: The dashboard list gets really slow when there are a lot of dashboards. Archiving the dashboards should also make the search quicker. I am not technical enough to say how this should be achieved, but this is something to consider. I was also thinking if it makes sense to be able to archive charts, but I believe the complexity increases in that case. Or maybe this should also be thought of?

we have archive charts as well, will put work in creating a pr if this archived dashboards gets merged

[rusackas]

Love the idea. A couple early questions/comments:

• Would there be a show/hide Archived Items switch in the list view?
• Do we need to do anything with alerts/reports/charts/etc that are preferentially attached to Archived dashboards?
• Should we consider replacing "Delete" with "Archive" since this... seems safer?
• If the answer is NO to the last one, then should/could selecting "Delete" be migrated (in a similar way) to add a "deleted" status in the DB, but hides it completely from the UI? This would be a "soft delete" so things could be recovered by someone with DB access.
• I believe there was another SIP/PR that adds Published/Draft status for Charts. This would be relevant there too.

[ethan-l-geotab]

Thanks for the feedback.

1. Should overhauling the existing publishing/draft system be in the scope of this sip? It seems to have a large scope, but I'm totally for it. Seems like the right way to do it to be honest, but I wasn't so sure such a big update would be approved without a big headache.
2. I think that modifying the status would be a good place to start. I'm open to other suggestions, not married to this idea, just what I had coded out at the moment. Theres no way of seeing both archived along with the other states at the same time the way it's done right now.

3. I think that alerts/reports and stuff that are attached to archived dashboards should NOT be modified. Don't want to inadvertently break someone else's workflow i guess?
4. I think archiving and deleting although share a similar purpose are distinct and soft deleting is something that might be better addressed in the future?
5. Regarding the Published/Draft status for charts. Would be easier starting off with the triple status vs refactoring everything to work with the triple status. I didn't make a SIP for it quite just yet, but if we want archiving for it I think perhaps that PR can just be closed and work on it can be done with it under this SIP. Or I create a new one SIP regarding Draft/Publish/Archive for charts if that's preferable. feat(charts): chart publishing UI #32969

[zuzana-vej]

Very exciting thanks for the proposal!
Few minor queestions

"Going from published to archived will unpublish it and put it back to draft."

Can you clarify this? if you archive published dashboard, is the status draft or archived?

2. Alerts & reports: To @rusackas question/point about alerts & reports. While we don't want to stop exiting alerts/reports, in ideal case, owners of those alerts/reports would be notified in some way that the dashboard their report is referencing has been archived.

3. Currently dashboard owner can flip dashboard from draft to published and back by clicking the little button next to be dashboard's name. But to archive it, users will do it via dropdown. What are the thoughts of these two pieces of UX being different? If marking as archived is done via the dropdown, is the button next to dashboard's name just to flip between draft and published?

4. @rusackas question: "Should we consider replacing "Delete" with "Archive" since this... seems safer?"

I think we should provide both options to users - both Archive and Delete. Certainly want to keep Delete option around - just to not keep clutter around - broken / unused charts / dashboards etc.

Thanks!

[ethan-l-geotab]

1. This is without the overhaul of having triple states. Currently there is a "published" property in the dashboard model. I intended it to go "back to draft" once it is in archived. I will still consider it archived as that takes priority. but I figured i should do something with that value instead of leaving it as published. That being said, changing published -> state and having it hold Published, Draft and Archived would be better.
2. I guess a "This dashboard is archived" wouldn't hurt in the report or something near the top?
3. Open to ideas. I figured "archiving" could be tucked away somewhere hidden cuz it wont be a common operation? Currently we have a modal popup where users can choose between archiving and publishing upon clicking the existing "publish status" button. Literally this: