Skip to content

Commit 15f7dc9

Browse files
author
boonhapus
committed
add process-archiver
1 parent 322a8cf commit 15f7dc9

File tree

1 file changed

+61
-9
lines changed

1 file changed

+61
-9
lines changed

docs/guides/process-archiver.md

Lines changed: 61 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ hide:
88
Clean up your stale and forgotten __Answers__{ .fc-green } and __Liveboards__{ .fc-purple } to improve the health of
99
your __ThoughtSpot__ platform.
1010

11+
Part of running an efficient ThoughtSpot cluster is ensuring you maintain a healthy balance of new and existing content.
12+
As Administrators and Data Managers, we want to encourage users to find and interact with Answer and Liveboards which
13+
meaningfully drive the business forward.
14+
15+
Once your ThoughtSpot adoption grows, it is a good practice to regularly `identify` stale user content and remove it
16+
from the system. This helps your users continue to find relevant, timely, and useful content to interact with.
17+
1118
??? tinm "There is No Magic!"
1219

1320
Remember, __CS Tools__ wraps the __ThoughtSpot__ [__REST APIs__][ts-rest-v2]. This tool uses the following endpoints.
@@ -45,29 +52,74 @@ your __ThoughtSpot__ platform.
4552
```
4653
~cs~tools tools archiver remove --help
4754

55+
---
56+
4857
## Define a Process
4958

50-
Part of running an efficient ThoughtSpot cluster is ensuring you maintain a healthy balance of new and existing content.
51-
As Administrators and Data Managers, we want to encourage users to find and interact with Answer and Liveboards which
52-
meaningfully drive the business forward.
59+
!!! danger "Critical"
5360

54-
Once your ThoughtSpot adoption grows, it is a good practice to regularly `identify` stale user content and remove it
55-
from the system. This helps your users continue to find relevant, timely, and useful content to interact with.
61+
This step is important!! The Archiver is a bulk operation tool which can delete many objects at once. It's important
62+
to be careful!
63+
64+
Run the `identify` command to identify stale content using the same value for both `--recent-activity` and
65+
`--recent-modified` to define an "inactivity" threshold. Any visualization object which has not been opened, edited, or
66+
saved during this time will be identified in your __ThoughtSpot__ cluster with the tag name you specify with `--tag`.
67+
68+
<sub class=fc-purple>
69+
<b>Use the</b> `--syncer` <b>parameter to export a [CSV][syncer-csv] of the tagged objects and their respective owners.</b>
70+
</sub>
5671

5772
!!! tip ""
5873
??? abstract "Get the Command"
5974
```shell
6075
cs_tools tools archiver identify --help
6176
```
62-
6377
~cs~tools tools archiver identify --help
6478

65-
Run the `identify` command to identify stale content with the same value for both `--recent-activity` and
66-
`--recent-modified` to define an "inactivity" threshold. Any user-object which has not been opened, edited, or saved
67-
during this time will be identified in your __ThoughtSpot__ cluster with the tag name you specify with `--tag`.
79+
---
80+
81+
## Communicate with Users
82+
83+
Let your Users know that their visualizations may be removed from the __ThoughtSpot__ platform.
84+
85+
This is a good opportunity to leverage your internal :material-slack: __Slack__ or :material-microsoft-teams:
86+
__Microsoft Teams__ channels.
87+
88+
> __SAMPLE COMMUNICATION__{ .fc-green }
89+
>
90+
> *For the health and stability of the ThoughtSpot cluster, your Administration team is planning a reduction of
91+
> unutilized visualizations. As of `YYYY/MM/DD`, we will be removing all Answers and Liveboards tagged with the
92+
> `INACTIVE` tag.
93+
>
94+
> If you wish to keep your visualization or opt-out of the cleaning process, please remove the tag prior to
95+
> `YYYY/MM/DD`.*
96+
>
97+
98+
You should provide clear timelines to Users and aim for a 2 weeks notice before removing their visualizations.
99+
100+
---
101+
102+
## Clean Up the Cluster
68103

104+
Run the `remove` command to delete any content which still has the `INACTIVE` tag.
105+
106+
!!! danger "Critical"
107+
108+
__Remember__{ .fc-red } this is a :bomb: __DESTRUCTIVE__{ .fc-red } activity!
109+
110+
__CS Tools__ provides you the ability to export all tagged objects prior to removal from __ThoughtSpot__ using the
111+
`--directory PATH` and `--export-only` parameters. Using this alongside the `--syncer csv://directory=PATH` will provide
112+
you a total guarantee that you can restore the deleted object if a user comes back and requests it.
113+
114+
!!! tip ""
115+
??? abstract "Get the Command"
116+
```shell
117+
cs_tools tools archiver remove --help
118+
```
119+
~cs~tools tools archiver remove --help
69120

70121

122+
[syncer-csv]: ../../syncer/csv
71123
[ts-rest-v2]: https://developers.thoughtspot.com/docs/rest-apiv2-reference
72124
[ts-rest-searchdata]: https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fdata%2Fsearch-data
73125
[ts-rest-metadata-search]: https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fsearch-metadata

0 commit comments

Comments
 (0)