Page tree
Skip to end of metadata
Go to start of metadata

The white-labeled domain is customized using APIs. If you do not have a technical administrator or developer who can work with APIs, contact GoodData Customer Support.

This article describes which elements you can customize and includes a sample JSON for reference.

Contents:

When you create a white-labeled domain, references to GoodData in the Portal, error messages, and the Glossary of the Metric Editor are automatically replaced.

When executing calls to the APIs, use the white-labeled domain name. For more information about using APIs for white labeling, see API Reference.

To perform calls using https://secure.gooddata.com after migrating to the white-labeled domain, include the following HTTP header:

X-GDC-CHECK-DOMAIN=false

If you forget this header, you receive an error message like the following:

javax.net.ssl.SSLException: hostname in certificate didn't match: !=


Customizable Elements

Verify that all assets specified by URL are in locations that are publicly available on the Internet. See What You Can White-Label to see how customized versions of these elements appear in the GoodData Portal.

On the GoodData portal, you can white-label:

Graphics and text

  • organizationName (required)
    Name of your organization on the GoodData platform. This value is used in the copyright text and in the body of emails generated by the Portal. This value is not displayed in the Portal footer.
    Example: Copyright 2014 <organizationName>, all rights reserved
    Format: string
  • logoURL (required)
    Logo displayed in the top-left corner of the Portal. Provide a link to this logo.
    Format: 120 x 25 px in PNG format
  • applicationTitle (required)
    Text in the browser title bar or tab title. Also appears on the registration and login pages.
    Example: <My Company> Analytics
  • isBranded
    Specifies whether the following elements are hidden (when set to true) or displayed (when set to false):
    • the Documentation link under Help and in the Portal footer; 
    • the question mark icons indicating the embedded help; 
    • the GoodData logo on the top right corner (for embedded mode only).
    By default, isBranded is set to true, and the elements are hidden.
  • faviconUrl
    Image that appears in the browser address bar. Provide a link to this icon.
    Format: 16 x 16, 32 x 32, 48 x 48, or 64 x 64 px; ICO format
  • appleTouchIconUrl
    The desktop icon that iOS users see when they save a GoodData page to desktop. Provide a link to this icon.
    Format: 114 x 114px, PNG
  • applicationBackgroundColor
    Specifies a custom background color for the dashboard. This color is not applied to the login, logout, registration, invitation or confirmation pages.
    Format: HTML color code
  • activeColor
    Specifies the underline color on active dashboard sections.
    Format: HTML color code
  • highlightColor
    Specifies the color of a highlighted or selected element (link, button, selected item in a dropdown, and so on) on a dashboard in the Dashboards section. This parameter is valid only when you have the new look-and-feel of the Dashboards section enabled. For more information, see 'Dashboard UI Visual Refresh' in Platform Settings.
    Format: HTML color code

    Set the highlightColor parameter to a color that has enough contrast to be clearly visible on the white dashboard background. Avoid setting this parameter to colors that are too light.

  • headerTextColor
    Specifies a custom color for the text on the dashboard header.
    Format: HTML color code
  • headerColor
    Specifies a custom color for the dashboard header.
    Format: HTML color code

UI elements to toggle on and off

  • displayFlashNews (required)
    Specifies whether to display the status bar that appears in the Portal after a new GoodData platform release. This status bar links to information published by GoodData. Can be disabled.
  • displayProjects (required)
    Specifies whether users can select projects on the project picker menu located in Account > Active Projects. Can be disabled.

  • displayAccountPage (required)
    Specifies whether users can review their account details on the Account menu. Can be disabled.

WalkMe configuration

Email addresses and URLs

Specify fully-qualified or relative URLs.

  • supportEmail (portalSettings section)
    Email address to which tickets are sent when users select Help > Submit Ticket. Can be disabled.
  • supportForumUrl
    URL to which users are directed when they select Help > Visit Support or click Help in the dashboard footer. Can be disabled.
  • privacyPolicyUrl
    URL to which users are directed when they click the Privacy Policy link in the Portal footer or select Account > Personal Information > privacy policy. Can be disabled.
  • documentationUrl
    URL to which users are directed when they click the Help link in the Portal footer or select Help > Documentation. Can be disabled.
  • securityStatementUrl
    URL to which users are directed when they click the Security Statement link in the Portal footer. Can be disabled.
  • termsOfUseUrl
    URL to which users are directed when they click the Terms of Use link in the Portal footer. Can be disabled.
  • trustUrl
    URL to which users are directed when they click the Trust link in the Portal footer. Can be disabled.

SSO configuration

  • showSSOCustomUnauthorizedLoginPage
    When set to true, the users logged in by SSO are directed to a custom 'not authorized' page instead of the default GoodData 'login' page. The custom 'not authorized' page URL is defined by the ssoExpiredUrl parameter.
  • ssoExpiredUrl
    URL (fully-qualified or relative) of the custom 'not authorized' page to which users are directed instead of the default GoodData 'not authorized' page when their SuperSecure Token expires or is not valid. Can be disabled.

  • ssoUnauthorizedUrl
    URL (fully-qualified or relative) of the custom 'not authorized' page to which users are directed instead of the default GoodData 'not authorized' page when the users are trying to access a project that they are not authorized to access. Can be disabled.

  • ssoLogoutUrl
    URL (fully-qualified or relative) of the custom 'logout' page to which users are directed instead of the default GoodData 'logout' page when they log out of the application. Can be disabled.

Login and registration page elements

  • brandColor
    Narrow strip of color on the top of the Login and Registration pages.
    Format: HTML color code
  • largeLogoUrl
    Logo that appears on the Login and Registration pages.
    Format: 130px maximum height, 470px maximum width, PNG preferred
  • hideRegistration
    Hide the link to the registration form on the Login page. When it is hidden, users cannot register without being invited.

Customizable mail elements (under mailSettings)

For more information about specific email templates, see Email Templates.       

  • noReplyEmail (required)
    Email address from which scheduled reports are sent.
  • registrationEmail (required)
    Email address from which registration confirmation emails and forgotten password emails are sent.
  • invitationEmail (required)
    Email address from which project invitation emails are sent.
  • bccEmail (required)
    Email address that is blind-copied on invitation emails.
  • supportEmail (required)
    Email address to which emails to your customer support are sent. Address also appears in the body of some emails.
  • supportPhone (required)
    Phone number for reaching your customer support. This phone number appears in email templates.
  • suppressProjectLinks (optional, boolean)
    Suppress hyperlinks for project in email footers. This is for use with white-labeled dashboards where the hyperlink leads to a GoodData branded view of the relevant dashboard.

Sample JSON

The following sample illustrates the structure of the JSON payload for the white label API. See the GoodData API documentation for White Labeling.

{
"settings":{ 
    "mailSettings":{ 
       "noReplyEmail":"noreply@example.com", 
       "registrationEmail":"reg@example.com",
       "invitationEmail":"inv@example.com", 
       "bccEmail":"bcc@example.com", 
       "supportEmail":"support@example.com", 
       "supportPhone":"+420 123 456 789",
       "suppressProjectLinks":true
    }, 
    "portalSettings":{ 
        "applicationTitle":"Custom analytics",
        "isBranded": true,
        "faviconUrl":"/favicon",
        "organizationName":"My domain", 
        "displayFlashNews":false, 
        "logoUrl":"http://www.example.com/mynewlogo.jpg", 
        "displayProjects":false, 
        "displayAccountPage":true, 
        "supportEmail":"support@example.com", 
        "supportForumUrl":"/link/to/support/forums", 
        "privacyPolicyUrl":"/privacyPolicy", 
        "documentationUrl":"/help/link", 
        "securityStatementUrl":"/security", 
        "termsOfUseUrl":"/tos", 
        "trustUrl":"/trust", 
        "activeColor":"#F7FE2E",
        "highlightColor":"#E14E2E",
        "headerColor":"#FF0040"
        "headerTextColor":"#610B38"
        "appleTouchIconUrl":"/icon.png", 
        "applicationBackgroundColor":"#999", 
        "hideRegistration":false,
        "brandColor":"#999",
        "largeLogoUrl":"http://www.example.com/largelogo.jpg",
        "walkMe":"9co9eaewd2b3ntqz3slw9co9eaewd2b3",
        "showSSOCustomUnauthorizedLoginPage":true,
        "ssoExpiredUrl":"/expired",
        "ssoUnauthorizedUrl":"/unauthorized",
        "ssoLogoutUrl":"/logout"
		}
    } 
}


Save

Save

Save

Save

Save

Save

Save

  • No labels