For each embed user you can, at any point in time, enable or disable several features related to dashboards, datasets, and editing dashboards in the Embedded Dashboard Editor. All these feature flags can be enabled or disabled within the API authorization request, to retrieve the desired embed token for your user.
const Luzmo = require('@luzmo/nodejs-sdk');
var client = new Luzmo({
api_key: '< Your API key >',
api_token: '< Your API token >'
});
let promise = client.create('authorization', {
type: 'embed',
username: '12345678',
suborganization: 'Burrito Co.',
name: 'Embed user',
email : 'embed_user@example.com',
access: {
collections: [
{
id: '< collection ID>',
inheritRights: 'use'
}
]
},
role: 'designer',
feature_overrides: ['!flag_alerting', 'flag_opendataboard']
});
promise.then(function(result){
// return result.id and result.token to the client
})
const Luzmo = require('@luzmo/nodejs-sdk');
var client = new Luzmo({
api_key: '< Your API key >',
api_token: '< Your API token >'
});
let promise = client.update('user', '<your user id>',
{
feature_overrides: ['!flag_alerting']
});
The feature flags below target general features which may benefit user experience.
| feature_flag | Default state | Description |
|---|---|---|
| flag_acceleration | Enabled "flag_acceleration" |
Create and manage warp acceleration. More information on the Warp feature can be found in this Academy article. |
| flag_ai_chart_generator | Enabled "flag_ai_chart_generator" |
Availability of AI-powered chart creation. This flag controls the visibility of the "Suggestions" and "Prompt" tabs in the Add Item menu in the Dashboard Editor. Both tabs offer ways to build charts with the power of AI. |
| flag_alerting | Enabled "flag_alerting" |
Create and manage alerts. More information on the Alerting feature can be found in this Academy article. |
| flag_commenting | Enabled "flag_commenting" |
See and add comments to a dashboard.
If disabled, will hide all dashboard end user comments and EDE comment section |
| flag_dashboard_variants | Enabled "flag_dashboard_variants" |
Ability to create and retrieve dashboard variants in the embedded editor. If disabled, the original dashboard will always be loaded, even if a favorited variant exists for your user. |
| flag_export | Enabled "flag_export" |
Create exports of dashboards and charts. |
| flag_export_show_filters | Enabled "flag_export_show_filters" |
Controls visibility of the "Use currently applied filters" toggle in the Export tab of Share Dashboard modal |
| flag_export_email | Enabled "flag_export_email" |
Controls visibility of the email and scheduling options in the Export tab of Share Dashboard modal |
| flag_private_sharing | Enabled "flag_private_sharing" |
Create a public share link.
Share links can never be created in the Embedded Dashboard Editor, this flag is thus only applicable to users who will log in to the Luzmo application |
| flag_replace_dashboard_datasets | Enabled "flag_replace_dashboard_datasets" |
Controls visibility of "Replace datasets" feature |
| flag_team_sharing | Enabled "flag_team_sharing" |
Share dashboards and datasets with groups or other users within their suborganization. |
The feature flags related to the editor have been subdivided into sets of flags that touch datasets, dashboards, and editor UI elements.
| feature_flag | Default state | Description |
|---|---|---|
| flag_create_datasets | Enabled "flag_create_datasets" |
Add own datasets. Below you can find a list of flags that you can specify to enable an users to use one or more connectors that Luzmo provides. |
| flag_open_databoard | Enabled "flag_open_databoard" |
Open datasets details (i.e. showing all columns and row-level data). |
| flag_search_datasets | Enabled "flag_search_datasets" |
Use the datasets search functionality that Luzmo provides, and see `Available datasets` (datasets that are accessible, but not used in the current dashboard). |
| feature_flag | Default state | Description |
|---|---|---|
| flag_add_items | Enabled "flag_add_items" |
Controls visibility of the "Add items" button in the dashboard editor + the "Clone" button in the chart hover menu |
| flag_change_dashboard_title | Enabled "flag_change_dashboard_title" |
Change the title of dashboards. |
| flag_change_language | Enabled "flag_change_language" |
Add and change languages of a dashboard and dataset. |
| flag_change_lookup_filtering | Enabled "flag_change_lookup_filtering" |
Change the lookup filtering toggle in dashboards. More information on lookup filtering can be found in this Academy article. |
| flag_change_screenmode | Enabled "flag_change_screenmode" |
Select screenmodes in the dashboard editor. |
| flag_css_inject | Enabled "flag_css_inject" |
Add, alter and remove CSS injected in dashboards. This Academy article shows you how you can use this flag to lock the dashboard styling for designers. |
| flag_customize_screenmodes | Enabled "flag_customize_screenmodes" |
Open the screenmode management modal from the dashboard editor. |
| flag_remove_items | Enabled "flag_remove_items" |
Controls visibility of the "Delete" button in the chart hover menu |
| flag_side_menu_data | Enabled "flag_side_menu_data" |
Controls visibility of the "Data" button in the dashboard editor side menu |
| flag_side_menu_edit_item | Enabled "flag_side_menu_edit_item" |
Controls visibility of the "Edit item" button in the dashboard editor side menu |
| flag_side_menu_filters | Enabled "flag_side_menu_filters" |
Controls visibility of the "Filters" button in the dashboard editor side menu + the "Add filter" button in the chart slot view |
| flag_side_menu_settings | Enabled "flag_side_menu_settings" |
Controls visibility of the "Settings" button in the dashboard editor side menu |
| flag_theming | Enabled "flag_theming" |
Select or create other dashboard themes. This Academy article shows you how you can use this flag to lock the dashboard styling for designers. |
| feature_flag | Default state | Description |
|---|---|---|
| flag_change_side_menu_position | Enabled "flag_change_side_menu_position" |
Change the editor's side menu position. |
| flag_tour | Enabled "flag_tour" |
Visibility of the editor onboarding tour that Luzmo provides. |
| flag_version_history | Enabled "flag_version_history" |
Open the version history menu of dashboards. This only applies to dashboards for which the user has edit or owner rights. |
All feature flags mentioned below target specific data sources. Note that every flag below, except for "flag_local_upload", has been disabled by default, as most users do not require their own connections to be added.
| feature_flag | Default state | Description |
|---|---|---|
| flag_amazonathena | Disabled "!flag_amazonathena" |
Connect to Amazon Athena. |
| flag_asana | Disabled "!flag_asana" |
Connect to Asana. |
| flag_bigquery | Disabled "!flag_bigquery" |
Connect to Google BigQuery. |
| flag_clickhouse | Disabled "!flag_clickhouse" |
Connect to Clickhouse. |
| flag_databricks | Disabled "!flag_databricks" |
Connect to Databricks. |
| flag_elasticsearch | Disabled "!flag_elasticsearch" |
Connect to Elasticsearch. |
| flag_googledrive | Disabled "!flag_googledrive" |
Connect to Google Drive. |
| flag_googleanalytics | Disabled "!flag_googleanalytics" |
Connect to Google Analytics. |
| flag_local_upload | Enabled "flag_local_upload" |
Locally upload files to use them in dashboards. |
| flag_mariadb | Disabled "!flag_mariadb" |
Connect to MariaDB. |
| flag_mongodb | Disabled "!flag_mongodb" |
Connect to MongoDB. |
| flag_mysql | Disabled "!flag_mysql" |
Connect to MySQL. |
| flag_oracle | Disabled "!flag_oracle" |
Connect to Oracle. |
| flag_panoply | Disabled "!flag_panoply" |
Connect to Panoply. |
| flag_pipelinedb | Disabled "!flag_pipelinedb" |
Connect to PipelineDB. |
| flag_postgresql | Disabled "!flag_postgresql" |
Connect to PostGreSQL. |
| flag_presto | Disabled "!flag_presto" |
Connect to Presto. |
| flag_redshift | Disabled "!flag_redshift" |
Connect to Amazon Redshift. |
| flag_saphana | Disabled "!flag_saphana" |
Connect to SAP HANA. |
| flag_snowflake | Disabled "!flag_snowflake" |
Connect to Snowflake. |
| flag_sqlserver | Disabled "!flag_sqlserver" |
Connect to SQL Server. |
| flag_stardog | Disabled "!flag_stardog" |
Connect to Stardog. |
| flag_synapse | Disabled "!flag_synapse" |
Connect to Synapse. |
| flag_trino | Disabled "!flag_trino" |
Connect to Trino. |
In case there are other features you would like to toggle for (certain) users, do not hesitate to use our Public roadmap's "Submit an idea" button, and explain which use-case you want to implement and why it is important to you! 😊
In the next article, you can learn more about how to easily manage the access granularity of your different dashboards and datasets.