Configure Various Features via Platform Settings

The platform settings allow you to activate or configure selected features on the GoodData platform that are currently not universally available (for example, enable Analytical Designer). Use the platform settings to test if a feature works in your particular platform environment. If you are not happy with the results, you can easily revert to your original setting.

Change only the settings that are documented in this section. Other settings can be removed or may stop working at any time without warning.

Only carry out these actions if you are sure of what you are doing. Otherwise, contact GoodData Support.

For more information on the GoodData terminology, see GoodData Glossary.

Contents:

Hierarchical Levels of Applying Platform Settings

When you configure the platform settings, the activated features are applied in your environment hierarchically in the following order:

domain -> project group -> project

For example, settings configured at the domain level are inherited by the project groups (that is, by all the projects that have the same authorization token, see Find the Project Authorization Token) and the projects under this domain. Settings configured at the project group level are inherited only by the underlying projects (including those that may be created using the same authorization token in the future).

  • If you have a domain (both white-labeled and not white-labeled), you can configure the platform settings for the domain, a project group, or a specific project.
  • If you do not have a domain, you can configure the platform settings only for a specific project. To configure the platform settings for a project group, contact GoodData Support.

You cannot configure the platform settings for an individual user.

Configure a Platform Setting

For the list of the available platform settings to configure, their names and available values including the defaults, see Available Platform Settings.

  • To configure a platform setting for a project, you must be a project admin and know the project ID (see Find the Project ID).
  • To configure a platform setting for a project group or a domain, you must be a domain admin.

Steps:

  1. Go to the gray page for configuring the platform settings.
    • For a specific project:

       https://{your.domain.com}/gdc/projects/{project_id}/config/
    • For a project group:

       https://{your.domain.com}/gdc/projectGroups/{authorization_token}/config/
    • For a domain:

       https://{your.domain.com}/gdc/domains/{domain_name}/config
    The page with the current platform settings opens.
  2. Scroll down to the bottom of the page to the Config section, and fill in the fields:
    • In the Key field, enter the name of the platform setting.
    • In the Value field, enter the value to set the platform setting to.
    For the list of the available platform settings to configure, their names and available values including the defaults, see Available Platform Settings.
  3. Click Create config.
    The platform setting is configured. The page with the details of the newly configured setting opens.
  4. Log in to the GoodData Portal, and check that the feature associated with the configured platform setting functions correctly.

Switch a Platform Setting to Its Default

For the list of the available platform settings to configure, their names and available values including the defaults, see Available Platform Settings.

  • To set a platform setting to its default in a project, you must be a project admin and know the project ID (see Find the Project ID).
  • To configure a platform setting for a project group or a domain, you must be a domain admin.

Steps:

  1. Go to the gray page for configuring the platform settings.
    • For a specific project:

       https://{your.domain.com}/gdc/projects/{project_id}/config/
    • For a project group:

       https://{your.domain.com}/gdc/projectGroups/{authorization_token}/config/
    • For a domain:

       https://{your.domain.com}/gdc/domains/{domain_name}/config
    The page with the current platform settings opens.
  2. Locate the platform setting that you want to switch back to its default, and click its self link.
    The page with the setting details opens. The current value of the platform setting is displayed in the Value field.
  3. Click Delete config.
    The page with the current platform settings opens. The updated setting is now set to its default value.

  4. Log in to the GoodData Portal, and check that the feature associated with the configured platform setting functions correctly.

Available Platform Settings

Change only the settings that are documented in this section. Other settings can be removed or may stop working at any time without warning.

Only carry out these actions if you are sure of what you are doing. Otherwise, contact GoodData Support.

Change the default state of data catalog groups in Analytical Designer

Set the default state of groups of the loaded data catalog as expanded or collapsed.

  • Name: ADCatalogGroupsExpanded
  • Default: Disabled
  • To enable and have all groups expanded after loading, set it to true.

Change the number of projects downloaded in one query

Change the number of projects that should be retrieved and downloaded from Data Sources in one query. This setting is applied only to Automated Data Distribution (ADD) v2 load tasks with LCM segments configured.

For data load in incremental mode:

  • Name: dataload.incrementalProjectsChunkSize
  • Default: 100
  • To customize, set it to your preferred number (an integer that equals or is greater than 1).

For data load in full mode:

  • Name: dataload.fullProjectsChunkSize
  • Default: 4
  • To customize, set it to your preferred number (an integer that equals or is greater than 1).

Customize the link of the header logo that appears on the GoodData Portal in the top left corner.

  • Name: portalLogoPage
  • Default: The URL of the lastly opened report in the Reports section (if available); otherwise, none
  • To customize, set it to your desired URL (must start with https://). To link to another section in the GoodData Portal, the URL must start with / (for example, /dashboards/ for the Dashboards section or /analyze/ for Analytical Designer).

Customize the link in the invitation email so that the invited user is redirected to the URL where your custom application runs (see Gooddata.UI: Set Up Authentication and Single Sign-On) instead of your white-labeled domain page.

  • Name: invitationWelcomePage
  • Default: The URL of your white-labeled domain page
  • To customize, set it to the URL where your application runs (for example, https://my.app.com).

Disable Analytical Designer

Disable Analytical Designer (see Analytical Designer) and hide it from the GoodData Portal.

  • Name: analyticalDesigner
  • Default: true (Analytical Designer enabled)
  • To disable, set it to false.

Disable CSV Uploader

Disable CSV Uploader (see Load CSV Files to Your Workspace) and hide it from the GoodData Portal.

  • Name: enableCsvUploader
  • Default: true (CSV Uploader enabled)
  • To disable, set it to false.

Disable KPI Dashboards

Disable KPI Dashboards (see KPI Dashboards) and hide them from the GoodData Portal.

Before disabling KPI Dashboards, delete all previously created dashboards. Otherwise, the KPI Dashboards section will still be visible.

  • Name:enableAnalyticalDashboards
  • Default:true (KPI Dashboards enabled)
  • To disable, set it to false.

Disable duplication of KPI Dashboards

Disable the possibility to duplicate KPI Dashboards.

  • Name:enableKPIDashboardSaveAsNew
  • Default:true (KPI Dashboards can be duplicated)
  • To disable, set it to false.

Disable the cell limit for table reports

Disable the cell limit for table reports.

The cell limit is applied to table reports. This limit specifies the maximum number of cells in a table report that a browser can display without impacting performance. When the limit is hit (a table report is too big to be displayed), the warning message appears instead of the report saying "Report too large to display". To show the report anyway, you can click Show anyway directly from the warning message.

When the cell limit is disabled, the warning message does not appear, and the report is automatically computed and displayed regardless of the number of cells but may take longer to render.

  • Name: disableCellLimit
  • Default: false (the cell limit applied; the warning message appears)
  • To disable, set it to true.

Disable the dashboard email feature

Hide the clock icon from the dashboard, which disables the ability to schedule emails from the dashboards (see Schedule Automatic Emailing of Dashboards to Yourself and Others).

  • Name: hideDashboardSchedule
  • Default: false (the clock icon displayed)
  • To hide, set it to true.

Disable the Reports and Dashboards sections

Disable the Reports and Dashboards sections (see GoodData Portal) and hide them from the GoodData Portal.

  • Name: hidePixelPerfectExperience
  • Default: false (the Reports and Dashboards sections enabled)
  • To disable, set it to true.

Enable adding recipients to dashboard schedule emails

Enable adding recipients other than yourself to dashboard schedule emails (see Schedule Automatic Emailing of Dashboards to Yourself and Others).

  • Name: dashboardScheduleRecipients
  • Default: false (cannot add other recipients)
  • To enable adding other recipients, set it to true.

Enable group items in Data Catalog in Analytical Designer

Enable item grouping in Data Catalog (see Data Catalog in Analytical Designer) by tags or folders.

  • Name: AdCatalogGrouping
  • Default: Disabled (item grouping disabled)
  • To enable, set it to ByFolders or ByTagNamingConvention.

Enable weeks in date filters in Analytical Designer and KPI Dashboards

Enable weeks in date filters in Analytical Designer and KPI Dashboards.

This platform setting only enables weeks in date filters in the Analytical Designer and KPI Dashboards sections of the GoodData Portal. To be able to fully use the filtering by weeks (that is, use the week attribute to filter your data in insights and KPI dashboards, compare the data to the previous period or the same period of the last year in week filters, and use weeks when customizing your date filter on KPI Dashboards), you also have to complete other steps. For more information, see Enable Weeks in Date Filters.

  • Name: enableWeekFilters
  • Default: false
  • To enable weeks, set it to true.

Set the first day of the week in date filters to Monday

Set the first day of the week in the calendar in date filters (see Filter for Dates) to Monday instead of Sunday.

This setting applies only for the dashboards available under the Dashboards section on the GoodData Portal. This setting does not affect the date filters in Analytical Designer or KPI Dashboards.

  • Name: weekStartOnMondayEnabled
  • Default: false (first day is Sunday)
  • To switch to Monday, set it to true.

You can also change the first day of the week from your user account on the GoodData platform (see Set First Day of Week in Date Filters to Monday). This change applies only to your user account.

Set the timeout for the embedded dashboard to trigger the 'embedded.ready' event

Set the timeout (in seconds) for waiting for the embedded dashboard to trigger the event "Dashboard export initiated - embedded content completed loading" (the embedded.ready event), which indicates that the content of the embedded dashboard completes loading. For more information, see Embedded Dashboard Events.

  • Name: embeddedReadyTimeout
  • Default: 30
  • To set the timeout, set it to your preferred timeout (an integer representing the number of seconds).

Switch to the latest version of the Extensible Analytics Engine (XAE)

The latest version of the Extensible Analytics Engine (see Extensible Analytics Engine (XAE) - FAQ) allows you to use the following:

  • The enhanced version of the COUNT function (see COUNT) and modeling many-to-many relationships in logical data models (LDM)
  • Filter data by weeks in Analytical Designer or KPI Dashboards, compare the data to the previous period or the same period of the last year in week filters, and use weeks when customizing your date filter on KPI Dashboards

    Switching to the latest version of XAE only enables XAE to properly process week filters in Analytical Designer and KPI Dashboards. To be able to fully use the filtering by weeks, you also have to complete other steps. For more information, see Enable Weeks in Date Filters.

Before switching, review Upgrading XAE to Version 3.

  • Name: xae_version
  • Default: 1 (the older version in use)
  • To switch, set it to 3.

Switch to the new look-and-feel of the Dashboards section

Update the user interface of the Dashboards section on the GoodData Portal with more attractive up-to-date visuals. For more information, see these Release Notes.

  • Name: newUIEnabled
  • Default: classic
  • To switch to the new look-and-feel, set to indigo.

Treat null values as zero in Analytical Designer

Treat null values as zero when filtering insights by values (see Filter Insights by Measure Values).

  • Name: ADMeasureValueFilterNullAsZeroOption
  • Default: EnabledUncheckedByDefault (treat as zero enabled and option deselected)
  • To enable and automatically select the option, set it to EnabledCheckedByDefault.
  • To hide the checkbox, set it to Disabled.
Powered by Atlassian Confluence and Scroll Viewport.