Skip to content

Commit 905ef6f

Browse files
authored
docs: Saved Reports in Cube Cloud (#9607)
1 parent 43f47d8 commit 905ef6f

File tree

6 files changed

+112
-4
lines changed

6 files changed

+112
-4
lines changed

docs/pages/product/apis-integrations/google-sheets.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,14 @@ Click <Btn>Edit</Btn> to chnage the query or the location.
117117
highlight="inset(15% 0 25% 76.5% round 10px)"
118118
/>
119119

120+
You can also manage saved reports in the <Btn>[Saved Reports][ref-saved-reports]</Btn> page
121+
in Cube Cloud.
122+
120123

121124
[link-google-sheets]: https://workspace.google.com/products/sheets/
122125
[link-marketplace-listing]: https://workspace.google.com/u/0/marketplace/app/cube_cloud_for_sheets/641460343379
123126
[ref-playground]: /product/workspace/playground
124127
[ref-views]: /product/data-modeling/concepts#views
125128
[ref-pre-aggs]: /product/caching/using-pre-aggregations
126-
[ref-sql-api-enabled]: /product/apis-integrations/sql-api#cube-cloud
129+
[ref-sql-api-enabled]: /product/apis-integrations/sql-api#cube-cloud
130+
[ref-saved-reports]: /product/workspace/saved-reports

docs/pages/product/apis-integrations/microsoft-excel.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,9 @@ Click <Btn>Edit</Btn> to chnage the query or the location.
123123
highlight="inset(22.5% 0 20% 72.5% round 10px)"
124124
/>
125125

126+
You can also manage saved reports in the <Btn>[Saved Reports][ref-saved-reports]</Btn> page
127+
in Cube Cloud.
128+
126129

127130
[ref-excel]: /product/configuration/visualization-tools/excel
128131
[ref-mdx-api]: /product/apis-integrations/mdx-api
@@ -132,4 +135,5 @@ Click <Btn>Edit</Btn> to chnage the query or the location.
132135
[ref-pre-aggs]: /product/caching/using-pre-aggregations
133136
[ref-sql-api-enabled]: /product/apis-integrations/sql-api#cube-cloud
134137
[link-excel-addins]: https://support.microsoft.com/en-us/office/add-or-remove-add-ins-in-excel-0af570c4-5cf3-4fa9-9b88-403625a0b460
135-
[link-ms-appsource]: https://appsource.microsoft.com/en-us/product/office/WA200008486
138+
[link-ms-appsource]: https://appsource.microsoft.com/en-us/product/office/WA200008486
139+
[ref-saved-reports]: /product/workspace/saved-reports

docs/pages/product/workspace.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ editor to build and enhance the data model of your semantic layer.
1919
- Use the [development mode][ref-dev-mode] and [environments][ref-environments] to
2020
collaborate and test features before going to production.
2121
- Use [Playground][ref-playground] to run queries and test the data model.
22+
- Use [Saved Reports][ref-saved-reports] to manage reports saved from Playground and
23+
spreadsheet integrations, i.e., [Cube Cloud for Sheets][ref-sheets-integration] and
24+
[Cube Cloud for Excel][ref-excel-integration].
2225
- Use [Chart Prototyping][ref-vizard] to generate code of a front-end
2326
application that works with Cube.
2427
- Use [SQL Runner][ref-sql-runner] to inform the development of the data
@@ -76,4 +79,7 @@ With Cube Core, you can:
7679
[ref-semantic-catalog]: /product/workspace/semantic-catalog
7780
[ref-encryption-keys]: /product/workspace/encryption-keys
7881
[ref-cube-store-encryption]: /product/caching/running-in-production#data-at-rest-encryption
79-
[ref-visual-model]: /product/workspace/visual-model
82+
[ref-visual-model]: /product/workspace/visual-model
83+
[ref-saved-reports]: /product/workspace/saved-reports
84+
[ref-sheets-integration]: /product/apis-integrations/google-sheets
85+
[ref-excel-integration]: /product/apis-integrations/excel

docs/pages/product/workspace/_meta.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ module.exports = {
33
"vizard": "Chart Prototyping",
44
"data-model": "Data Model",
55
"visual-model": "Visual Model",
6+
"saved-reports": "Saved Reports",
67
"rollup-designer": "Rollup Designer",
78
"dev-mode": "Development mode",
89
"environments": "Environments",

docs/pages/product/workspace/playground.mdx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,17 @@ and will be restored when you open Playground once again.
124124

125125
You can also double-click on a query tab to give it a meaningful name.
126126

127+
### Saving a report
128+
129+
You can save a _query to a view_ by clicking <Btn>Save Report</Btn> in the top right corner.
130+
131+
<Screenshot
132+
src="https://ucarecdn.com/c4865552-59ab-4d20-bd7d-5310be07e16c/"
133+
highlight="inset(6% 0 88% 91% round 10px)"
134+
/>
135+
136+
You can manage saved reports in the <Btn>[Saved Reports][ref-saved-reports]</Btn> page.
137+
127138
## Viewing results
128139

129140
Click <Btn>Run Query</Btn> on the top to run (or re-run) the query and check the
@@ -216,4 +227,5 @@ manually.
216227
[ref-time-zone]: /product/apis-integrations/queries#time-zone
217228
[ref-row-limit]: /product/apis-integrations/queries#limit
218229
[ref-chart-prototyping]: /product/workspace/vizard
219-
[ref-boolean-filters]: /product/apis-integrations/rest-api/query-format#boolean-logical-operators
230+
[ref-boolean-filters]: /product/apis-integrations/rest-api/query-format#boolean-logical-operators
231+
[ref-saved-reports]: /product/workspace/saved-reports
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Saved Reports
2+
3+
Saved Reports provides a way to manage reports saved from [Playground][ref-playground]
4+
and spreadsheet integrations, i.e., [Cube Cloud for Sheets][ref-sheets-integration]
5+
and [Cube Cloud for Excel][ref-excel-integration].
6+
7+
<SuccessBox>
8+
9+
Saved Reports are available in Cube Cloud on
10+
[Premium and above](https://cube.dev/pricing) product tiers.
11+
12+
</SuccessBox>
13+
14+
<WarningBox>
15+
16+
Saved Reports are currently in preview.
17+
18+
</WarningBox>
19+
20+
You can [create reports](#creating-reports) and then [manage](#managing-reports) them:
21+
[view](#viewing-reports) reports, [organize](#organizing-reports) them into folders,
22+
and [share](#sharing-reports) them with your team.
23+
24+
## Creating reports
25+
26+
### Playground
27+
28+
You can compose a _query to a [view][ref-views]_ in [Playground][ref-playground] and then
29+
save it by clicking the <Btn>Save Report</Btn> button.
30+
31+
<Screenshot
32+
src="https://ucarecdn.com/c4865552-59ab-4d20-bd7d-5310be07e16c/"
33+
highlight="inset(6% 0 88% 91% round 10px)"
34+
/>
35+
36+
### Spreadsheets
37+
38+
You can create a report in [Cube Cloud for Sheets][ref-sheets-integration] or [Cube Cloud
39+
for Excel][ref-excel-integration]. When ready, click the <Btn>Save</Btn> button to save
40+
the report.
41+
42+
<Screenshot
43+
src="https://ucarecdn.com/b51aeae7-a0bf-450d-a7b4-849de68c1fa1/"
44+
highlight="inset(23% 0 72% 95% round 10px)"
45+
/>
46+
47+
## Managing reports
48+
49+
You can find all saved reports by going to <Btn>Saved Reports</Btn> in the top-level menu.
50+
51+
### Viewing reports
52+
53+
View reports in the root folder or navigate to subfolders to view reports there.
54+
55+
<Screenshot src="https://ucarecdn.com/21474fc2-17bb-45d0-a3da-09a0ae28ad02/" />
56+
57+
### Organizing reports
58+
59+
You can organize reports into folders. Click <Btn>+ New Folder</Btn> to create a new folder.
60+
61+
If you'd like to move a report into another folder, click <Btn>... → Move</Btn> and select
62+
the destination folder in the modal window.
63+
64+
<Screenshot src="https://ucarecdn.com/d9bc50ec-9875-479d-8a0e-53f4b748a07e/" />
65+
66+
### Sharing reports
67+
68+
You can share reports with members of your team by managing their [access
69+
control][ref-rbac] roles.
70+
71+
If you'd like to share a report with a team member, click <Btn>... → Share</Btn> and select
72+
the role in the modal window.
73+
74+
<Screenshot src="https://ucarecdn.com/d536dbed-a40d-450f-8adf-02a4b697d8df/" />
75+
76+
77+
[ref-playground]: /product/workspace/playground
78+
[ref-sheets-integration]: /product/apis-integrations/google-sheets
79+
[ref-excel-integration]: /product/apis-integrations/excel
80+
[ref-views]: /product/data-modeling/concepts#views
81+
[ref-rbac]: /product/workspace/access-control#managing-roles

0 commit comments

Comments
 (0)