From 6fd6fd0a0434672e74c57d6d419e71876b0ecb5c Mon Sep 17 00:00:00 2001 From: Michael Irvine Date: Wed, 23 Oct 2024 17:16:38 -0400 Subject: [PATCH 1/8] feat(docs): adds visual modeler page --- docs/pages/product/workspace/_meta.js | 1 + .../product/workspace/visual-modeler.mdx | 157 ++++++++++++++++++ 2 files changed, 158 insertions(+) create mode 100644 docs/pages/product/workspace/visual-modeler.mdx diff --git a/docs/pages/product/workspace/_meta.js b/docs/pages/product/workspace/_meta.js index 6f154b4bed8bc..0b05eebdbebe8 100644 --- a/docs/pages/product/workspace/_meta.js +++ b/docs/pages/product/workspace/_meta.js @@ -2,6 +2,7 @@ module.exports = { "playground": "Playground", "vizard": "Chart Prototyping", "data-model": "Data Model", + "visual-modeler": "Visual Modeler", "rollup-designer": "Rollup Designer", "dev-mode": "Development mode", "environments": "Environments", diff --git a/docs/pages/product/workspace/visual-modeler.mdx b/docs/pages/product/workspace/visual-modeler.mdx new file mode 100644 index 0000000000000..83f83c0b3e704 --- /dev/null +++ b/docs/pages/product/workspace/visual-modeler.mdx @@ -0,0 +1,157 @@ +# Visual Modeler + +With Cube Visual Modeler, non-technical users can actively participate in data +modeling without writing a single line of code, and code-proficient engineers +have the option of working in code or no-code. + + + +Visual Modeler is available in Cube Cloud on +[Enterprise](https://cube.dev/pricing) tier. +[Contact us](https://cube.dev/contact) for details. + + + + + +## Using Visual Modeler + +Cube Visual Modeler lets you see and edit your Cube data model in an easy-to-use, +graphical interface. You can also switch seamlessly between Visual Modeler and +the original code-based [Data Model editor][ref-data-model] depending on your needs. + +To open Visual Modeler, click on the "Show Canvas" in the top right of the Data Model +page. Visual Modeler will stay open until you go back to the code editor by clicking +the "View Code" button or "Show Code" on any cube or view node. + + + +## Cubes + +### Adding cubes + +To add a cube, click the "Add Cube" button in the top left of the Visual Modeler +screen. This brings up the Add Cube dialog where you can select a table from your +database, choose dimensions and primary keys, and review your choices before +submitting. + + + Note that you cannot add measures at this step. To do so, first add your cube, + then follow the instructions in [Editing cubes](#editing-cubes) or [Adding + dimensions and measures](#adding-dimensions-and-measures) below. + + + + +### Editing cubes + +To edit a cube, first select the cube on the canvas by clicking on it. Then, in +the sidebar, click "Edit" in the top right. This brings up a modal where you can +edit the cube's details (name, title, SQL, etc.), dimensions, measures, and +relationships. + +You may use this dialog to add dimensions, measures, and joins, or do so via the +[Adding dimensions and measures](#adding-dimensions-and-measures) and [Working +with joins](#working-with-joins) sections below. + + + +### Adding dimensions and measures + +To add a dimension or measure, first select a cube on the canvas by clicking on +it. Them, in the sidebar, click "Add Dimension" or "Add Measure." + + + +### Working with joins + +You can add or edit joins via the "Relationships" section of the Edit Cube dialog +(see "[Editing cubes](#editing-cubes)" above). + +Visual Modeler also lets you add joins visually by dragging a line on the canvas +from the side of one dimension to another. + + + +## Views + +### Adding views +To add a view, click the "Views" tab at the top of the canvas. Then, click "Add +View". This brings up a dialog where you can choose the base cube, set the view +details such as name and title, and add joins and join paths. + + + +### Editing views + +The same dialog may be used to edit existing views by selecting the view in the +dropdown, clicking on it in the canvas, and clicking "Edit" in the sidebar. + +## YAML mode + +All the dialogs mentioned above have a "YAML mode" where you can see and edit +the Cube YAML generated by Visual Modeler. This lets you add properties that +are not natively supported by the Visual Modeler GUI (for example [meta +tags][ref-meta]) or inspect the YAML you've generated before submitting it. + +To access YAML mode, click the "Create with YAML" or "Edit with YAML" button +at the bottom of the dialog. + + + +## Limitations + +Cube Visual Modeler does not natively support some features of the Cube data +model when adding or editing cubes and views. However, these may be added via +[YAML mode](#yaml-mode) or in the [data model code editor][ref-data-model]. + +For example, the following are not included in Visual Modeler: +- [Meta tags][ref-meta] +- [Segments][ref-segments] +- [Refresh keys][ref-refresh-keys], [pre-aggregations][ref-pre-aggregations], [subqueries][ref-sub-query], or [granularities][ref-granularities] on dimensions +- [Drill members][ref-drill-members] or [rolling windows][ref-rolling-window] on measures + +Cubes and views using those features will still be displayed in +Visual Modeler, but those fields can only be edited via [YAML mode](#yaml-mode) +or in the code editor. + +Additionally, Visual Modeler only allows editing of cubes and views that are +defined in YAML, not JavaScript, and it does not allow editing of [dynamic data +models][ref-dynamic-data-models] or models which use [Jinja][ref-jinja], although +they will still be displayed on the canvas. + +[ref-data-model]: /product/workspace/data-model +[ref-meta]: /reference/data-model/cube#meta +[ref-segments]: /reference/data-model/segments +[ref-refresh-keys]: /reference/data-model/cube#refresh_key +[ref-pre-aggregations]: /reference/data-model/pre-aggregations +[ref-sub-query]: /reference/data-model/dimensions#sub_query +[ref-granularities]: /reference/data-model/dimensions#granularities +[ref-drill-members]: /reference/data-model/measures#drill_members +[ref-rolling-window]: /reference/data-model/measures#rolling_window +[ref-dynamic-data-models]: /product/data-modeling/dynamic +[ref-jinja]: /product/data-modeling/dynamic/jinja \ No newline at end of file From 9c3defe59632f29390cd0c513465a67f088436a0 Mon Sep 17 00:00:00 2001 From: Michael Irvine Date: Thu, 24 Oct 2024 11:09:22 -0400 Subject: [PATCH 2/8] adds git flow recommendation --- .../product/workspace/visual-modeler.mdx | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/pages/product/workspace/visual-modeler.mdx b/docs/pages/product/workspace/visual-modeler.mdx index 83f83c0b3e704..9b7111dd0d03c 100644 --- a/docs/pages/product/workspace/visual-modeler.mdx +++ b/docs/pages/product/workspace/visual-modeler.mdx @@ -17,6 +17,29 @@ Visual Modeler is available in Cube Cloud on alt="Visual modeler screenshot" /> +## Setup and Git Flow +Contact your Cube account team to enable Cube Visual Modeler. + +For existing developers who are comfortable writing code, there is nothing +additional needed to set up Visual Modeler. They can simply use it alongside +their existing code-first workflow. + +If you would like business users to have self-serve access to Visual Modeler, +we recommend the following setup: +1. In your Cube deployment's settings, under the "Build & Deploy" tab, connect +it to a Git repository. +2. Disable direct commits to the main branch and disable merging to the main branch. + + + +This way, business users can submit pull requests for an admin to review via +Cube's git integration. This allows you to keep your Cube data model governed +while letting users who are less comfortable with code make contributions via +Visual Modeler. + ## Using Visual Modeler Cube Visual Modeler lets you see and edit your Cube data model in an easy-to-use, From 8a651c0587ee398672d528c3a49f9eae6c6ab34b Mon Sep 17 00:00:00 2001 From: Michael Irvine Date: Thu, 24 Oct 2024 11:16:03 -0400 Subject: [PATCH 3/8] mentions data graph --- docs/pages/product/workspace/visual-modeler.mdx | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/pages/product/workspace/visual-modeler.mdx b/docs/pages/product/workspace/visual-modeler.mdx index 9b7111dd0d03c..e3cdbc43c1e4a 100644 --- a/docs/pages/product/workspace/visual-modeler.mdx +++ b/docs/pages/product/workspace/visual-modeler.mdx @@ -20,6 +20,13 @@ Visual Modeler is available in Cube Cloud on ## Setup and Git Flow Contact your Cube account team to enable Cube Visual Modeler. + + Cube Visual Modeler replaces the [Data Graph][ref-data-graph] for accounts + where it is enabled. All functionality of the Data Graph is still present in + Visual Modeler plus new features to allow visual editing of your Cube data + model. + + For existing developers who are comfortable writing code, there is nothing additional needed to set up Visual Modeler. They can simply use it alongside their existing code-first workflow. @@ -36,9 +43,9 @@ it to a Git repository. /> This way, business users can submit pull requests for an admin to review via -Cube's git integration. This allows you to keep your Cube data model governed -while letting users who are less comfortable with code make contributions via -Visual Modeler. +Cube's git integration but do not have the ability to merge their own changes. +This allows you to govern your Cube data model while letting users who are less +comfortable with code make contributions via Visual Modeler. ## Using Visual Modeler @@ -167,6 +174,7 @@ defined in YAML, not JavaScript, and it does not allow editing of [dynamic data models][ref-dynamic-data-models] or models which use [Jinja][ref-jinja], although they will still be displayed on the canvas. +[ref-data-graph]: /product/workspace/data-model#data-graph [ref-data-model]: /product/workspace/data-model [ref-meta]: /reference/data-model/cube#meta [ref-segments]: /reference/data-model/segments From 0c44c10e18b25281712ca57ecbfd142eef9613da Mon Sep 17 00:00:00 2001 From: Michael Irvine Date: Thu, 24 Oct 2024 13:38:46 -0400 Subject: [PATCH 4/8] adds preview callout --- docs/pages/product/workspace/visual-modeler.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/pages/product/workspace/visual-modeler.mdx b/docs/pages/product/workspace/visual-modeler.mdx index e3cdbc43c1e4a..44522f98d7e77 100644 --- a/docs/pages/product/workspace/visual-modeler.mdx +++ b/docs/pages/product/workspace/visual-modeler.mdx @@ -12,6 +12,10 @@ Visual Modeler is available in Cube Cloud on + + Cube Visual Modeler is currently in preview. + + Date: Mon, 28 Oct 2024 12:19:12 -0400 Subject: [PATCH 5/8] uses btn tags --- .../product/workspace/visual-modeler.mdx | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/pages/product/workspace/visual-modeler.mdx b/docs/pages/product/workspace/visual-modeler.mdx index 44522f98d7e77..c646b3b2b025a 100644 --- a/docs/pages/product/workspace/visual-modeler.mdx +++ b/docs/pages/product/workspace/visual-modeler.mdx @@ -37,7 +37,7 @@ their existing code-first workflow. If you would like business users to have self-serve access to Visual Modeler, we recommend the following setup: -1. In your Cube deployment's settings, under the "Build & Deploy" tab, connect +1. In your Cube deployment's settings, under the Build & Deploy tab, connect it to a Git repository. 2. Disable direct commits to the main branch and disable merging to the main branch. @@ -57,9 +57,9 @@ Cube Visual Modeler lets you see and edit your Cube data model in an easy-to-use graphical interface. You can also switch seamlessly between Visual Modeler and the original code-based [Data Model editor][ref-data-model] depending on your needs. -To open Visual Modeler, click on the "Show Canvas" in the top right of the Data Model +To open Visual Modeler, click on the Show Canvas in the top right of the Data Model page. Visual Modeler will stay open until you go back to the code editor by clicking -the "View Code" button or "Show Code" on any cube or view node. +the View Code button or Show Code on any cube or view node. Add Cube button in the top left of the Visual Modeler screen. This brings up the Add Cube dialog where you can select a table from your database, choose dimensions and primary keys, and review your choices before submitting. @@ -89,7 +89,7 @@ submitting. ### Editing cubes To edit a cube, first select the cube on the canvas by clicking on it. Then, in -the sidebar, click "Edit" in the top right. This brings up a modal where you can +the sidebar, click Edit in the top right. This brings up a modal where you can edit the cube's details (name, title, SQL, etc.), dimensions, measures, and relationships. @@ -105,7 +105,7 @@ with joins](#working-with-joins) sections below. ### Adding dimensions and measures To add a dimension or measure, first select a cube on the canvas by clicking on -it. Them, in the sidebar, click "Add Dimension" or "Add Measure." +it. Them, in the sidebar, click Add Dimension or Add Measure. Views tab at the top of the canvas. Then, click Add +View. This brings up a dialog where you can choose the base cube, set the view details such as name and title, and add joins and join paths. Edit in the sidebar. ## YAML mode @@ -149,7 +149,7 @@ the Cube YAML generated by Visual Modeler. This lets you add properties that are not natively supported by the Visual Modeler GUI (for example [meta tags][ref-meta]) or inspect the YAML you've generated before submitting it. -To access YAML mode, click the "Create with YAML" or "Edit with YAML" button +To access YAML mode, click the Create with YAML or Edit with YAML button at the bottom of the dialog. Date: Mon, 28 Oct 2024 12:22:09 -0400 Subject: [PATCH 6/8] adds to workspace tools list --- docs/pages/product/workspace.mdx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/pages/product/workspace.mdx b/docs/pages/product/workspace.mdx index 7538865e44ced..f6f9b34791393 100644 --- a/docs/pages/product/workspace.mdx +++ b/docs/pages/product/workspace.mdx @@ -17,6 +17,8 @@ In Cube Cloud, you can: - Use the [data model editor][ref-data-model] with the [development mode][ref-dev-mode] and [Rollup Designer][ref-rollup-designer] to build the data model of your semantic layer. +- Use [Visual Modeler][ref-visual-modeler] to build and edit your data model + using a canvas-based UI. - Access the data model through different [Environments][ref-environments]. - Use [Playground][ref-playground] to run queries and test the data model. - Use [Chart Prototyping][ref-vizard] to generate code of a front-end @@ -77,4 +79,5 @@ With Cube Core, you can: [ref-ai-assistant]: /product/workspace/ai-assistant [ref-semantic-catalog]: /product/workspace/semantic-catalog [ref-encryption-keys]: /product/workspace/encryption-keys -[ref-cube-store-encryption]: /product/caching/running-in-production#data-at-rest-encryption \ No newline at end of file +[ref-cube-store-encryption]: /product/caching/running-in-production#data-at-rest-encryption +[ref-visual-modeler]: /product/workspace/visual-modeler \ No newline at end of file From f89c3880519180a6faea82569c182dae1f53a649 Mon Sep 17 00:00:00 2001 From: Michael Irvine Date: Mon, 28 Oct 2024 12:58:54 -0400 Subject: [PATCH 7/8] adds data graph callout --- docs/pages/product/workspace/data-model.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/pages/product/workspace/data-model.mdx b/docs/pages/product/workspace/data-model.mdx index 1bc80d95b1d63..317c13d7b030f 100644 --- a/docs/pages/product/workspace/data-model.mdx +++ b/docs/pages/product/workspace/data-model.mdx @@ -63,6 +63,12 @@ there are any unsaved changes: ## Data Graph + + For Cube Cloud customers on the [Enterprise](https://cube.dev/pricing) tier, + the Data Graph is replaced by [Visual Modeler][ref-visual-modeler]. + Please see the [Visual Modeler page][ref-visual-modeler] for more details. + + In addition to exploring the code of data model files, you can view the visual representation of the data model, including relations between cubes. Click Show Graph in the top right part of the data model editor to @@ -162,3 +168,4 @@ If you'd like to use the UI to create a pre-aggregation, you can click on the [wiki-erd]: https://en.wikipedia.org/wiki/Entity–relationship_model [ref-rollup-designer]: /product/workspace/rollup-designer [ref-creating-deployment]: /product/deployment/cloud/deployments#creating-a-new-deployment +[ref-visual-modeler]: /product/workspace/visual-modeler \ No newline at end of file From 776a4944abf6e8b1e9b354dc5a7c9dead1e890a6 Mon Sep 17 00:00:00 2001 From: Michael Irvine Date: Mon, 28 Oct 2024 13:11:46 -0400 Subject: [PATCH 8/8] updates gitflow nad using visual modeler --- .../product/workspace/visual-modeler.mdx | 23 +++++++++---------- 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/docs/pages/product/workspace/visual-modeler.mdx b/docs/pages/product/workspace/visual-modeler.mdx index c646b3b2b025a..83405151cc86d 100644 --- a/docs/pages/product/workspace/visual-modeler.mdx +++ b/docs/pages/product/workspace/visual-modeler.mdx @@ -21,7 +21,7 @@ Visual Modeler is available in Cube Cloud on alt="Visual modeler screenshot" /> -## Setup and Git Flow +## Getting started Contact your Cube account team to enable Cube Visual Modeler. @@ -41,10 +41,7 @@ we recommend the following setup: it to a Git repository. 2. Disable direct commits to the main branch and disable merging to the main branch. - +See the [Continuous deployment][ref-continuous-deployment] page for more information. This way, business users can submit pull requests for an admin to review via Cube's git integration but do not have the ability to merge their own changes. @@ -57,15 +54,16 @@ Cube Visual Modeler lets you see and edit your Cube data model in an easy-to-use graphical interface. You can also switch seamlessly between Visual Modeler and the original code-based [Data Model editor][ref-data-model] depending on your needs. -To open Visual Modeler, click on the Show Canvas in the top right of the Data Model -page. Visual Modeler will stay open until you go back to the code editor by clicking -the View Code button or Show Code on any cube or view node. - +To open Visual Modeler, click on the Show Canvas button in the top +right of the [Data Model][ref-data-model] page. Visual Modeler will stay open +until you go back to the code editor by clicking the View Code +button or Show Code on any cube or view node. + ## Cubes ### Adding cubes @@ -189,4 +187,5 @@ they will still be displayed on the canvas. [ref-drill-members]: /reference/data-model/measures#drill_members [ref-rolling-window]: /reference/data-model/measures#rolling_window [ref-dynamic-data-models]: /product/data-modeling/dynamic -[ref-jinja]: /product/data-modeling/dynamic/jinja \ No newline at end of file +[ref-jinja]: /product/data-modeling/dynamic/jinja +[ref-continuous-deployment]: /product/deployment/cloud/continuous-deployment \ No newline at end of file