White Label Configuration Guide

White Label Configuration Guide
Document publish date: 06/04/15
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #2
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
PROPRIETARY AND CONFIDENTIAL INFORMATION. This document may
not be disclosed to any third party, reproduced, modified or distributed without
the prior written permission of GoodData Corporation.
GOODDATA CORPORATION PROVIDES THIS DOCUMENTATION AS-IS
AND WITHOUT WARRANTY, AND TO THE MAXIMUM EXTENT
PERMITTED, GOODDATA CORPORATION DISCLAIMS ALL IMPLIED
WARRANTIES, INCLUDING WITHOUT LIMITATION THE IMPLIED
WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT AND
FITNESS FOR A PARTICULAR PURPOSE.
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #3
Table of Contents
Table of Contents
3
How to White Label an Existing Organization
5
Set up a CNAME and Acquire an SSL Certificate
6
Coordinate Rollout
7
Customize the White-Labeled Organization
9
Customizable Elements
9
Customizable Mail Elements (under mailSettings)
10
UI Elements to Toggle On and Off
11
Graphics and Text
11
Email Addresses and URLs
12
Login and Registration Page Elements
13
Sample JSON
14
How to Request and Customize a New White-Labeled Organization
16
Set Up a CNAME and SSL Certificate
17
Choose an Organization Administrator
18
Customize the Organization
19
Customizable Elements
19
Customizable Mail Elements (under mailSettings)
20
UI Elements to Toggle On and Off
21
Graphics and Text
21
Email Addresses and URLs
22
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #4
Login and Registration Page Elements
23
Sample JSON
24
Email Templates
25
Invitation email
25
Scheduled report email
26
Sent dashboard email
27
Registration email
28
Password reset email
28
What You Can White Label
29
Frequently Asked Questions about White Labeling
30
Where is my project- and user-specific storage located after I migrate to
the new white-labeled environment?
30
When I try to log in through the white-labeled URL, I get an error
message "Incorrect username or password.” Why is this?
30
Why does the API for creating a project return the following error when I
use it in a white-labeled organization?
31
When authenticating, my Java application returns this SSL certificate
exception:
31
When I log in to my white-labeled organization, I get an error that says
that my certificate has expired, that I am connecting to an unsecured site,
or that my connection is not private.
31
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #5
How to White Label an Existing Organization
You can remove elements of the GoodData Portal and optionally replace them
with your own branding. This customization is called white labeling. Whitelabeling is applied to a GoodData organization.
NOTE: If your enterprise has multiple GoodData organizations
and you want to apply white-labeling to only one, or if you want
to migrate users between organizations, please contact
GoodData Customer Support.
Key Benefits of White Labeling
l
l
Integrated branding. Deliver your GoodData solution under your own
brand, making the solution a part of your product suite.
GoodData within your domain. Integrate your GoodData solution into your
DNS domain, including a customizable application URL.
What You Can White Label
l
Names: Company names, application names, and even domain names.
l
Logo: Application logos, icons, and favicon.
l
l
l
l
Portal URLs and menus: URLs in the Portal that connect to GoodData
resources, as well as Support, Project, and Account menu items.
Email addresses: Send-from addresses in emails generated from the
Portal.
Selected components and text elements: Some components and text
elements of the Portal can be disabled through white labeling.
Selected skin elements: Some elements of the web page skin can be
styled to align them with your brand.
To see an example of white labeling, click here.
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #6
NOTE: You cannot white label the Portal layout or the format of
emails generated by the Portal.
Pre-requisites: To request white labeling, you must have a valid customer
contract with GoodData Corporation, including licensing of the white-labeling
service. For more information, contact your GoodData Account Manager.
Steps:
1. Gather the following assets:
l
l
l
Choose a URL for the white-labeled organization. For example:
https://analytics.yourcompany.com
Ask your organization administrator to set up a CNAME and generate
an SSL certificate
Project IDs of the projects to migrate or the customer token for your
current organization
2. Open a request to create the white-labeled organization at GoodData
Customer Support. Include the following assets, which you gathered in the
previous step, in this request:
l
URL for the white-labeled organization
l
Public and private components of the SSL certificate
l
Confirmation of CNAME creation
l
Project IDs or customer token
l
GoodData organization where you want to apply white labeling
GoodData coordinates the rollout schedule with you and creates the whitelabeled organization. This process typically takes two weeks.
3. Coordinate rollout of the white-labeled organization.
4. Customize the white-labeled organization using the GoodData APIs.
Set up a CNAME and Acquire an SSL Certificate
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #7
NOTE: An IT administrator typically performs these steps.
Create to the following resources so that GoodData Support can create a whitelabeled organization.
Steps:
1. Define a CNAME record to map the URL for the new white-labeled
organization to secure.gooddata.com. Apply this DNS change within
your domain.
For example, if your white-labeled organization should be accessible from
analytics.example.com, create a CNAME to point from that
destination to secure.gooddata.com.
2. Acquire an SSL Certificate for the new domain. This certificate must have
the following characteristics:
l
In PKCS12 format (preferred)
l
Maps to the CNAME
l
Contains both public and private components
Before you generate the SSL certificate, you must generate a Certificate
Signing Request (CSR) file. This file is required as part of the request to a
certificate authority for issuing a certificate. For more information, see Key
and CSR Generation Instructions.
3. Send both public and private components of the certificate and confirmation
of CNAME creation to the person managing the white-labeling process with
GoodData Customer Support.
Coordinate Rollout
When the white-labeled organization is ready to go live, you should coordinate its
rollout to the user community. This coordination is important because after the
white-labeled organization is exposed, users can no longer access projects and
dashboards through https://secure.gooddata.com. In the GoodData
Customer Support request for white-labeling, you must agree with Support on a
rollout date.
Steps:
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #8
1. Before rollout: l
l
l
Communicate the timeline of the rollout to all impacted users. Be sure
to coordinate this timeline with your GoodData organization
administrator.
Verify that users of the white-labeled environment organization
understand that they must use the new URL and will no longer be able
to access their projects and dashboards through
https://secure.gooddata.com.
Notify developers maintaining the white-labeled organization that they
must use the new domain for calls to the GoodData APIs.
Tip: To perform calls using
https://secure.gooddata.com after migrating to the
white-labeled organization, you must 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: !=
2. After rollout:
l
Ask users to log in to the new domain and verify access.
If users cannot access the white-labeled organization, ask your
administrator to add them using APIs or open a GoodData
Customer Support request.
NOTE: After users have been added to the
organization, if you use the Invite User API to add
users to specific projects, users receive an email
invitation, which may or may not have been
customized yet. When accepted, they have
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #9
immediate access to the project. To silently add
users to the project without sending an invitation,
please use the Add User API.
Customize the White-Labeled Organization
NOTE: The white-labeled organization is customized using
APIs. If you do not have a technical administrator or developer
who can work with APIs, please contact GoodData
Customer Support.
After the white-labeled organization is created, you can begin to customize it.
Review the list of customization options below and work with your organization
administrator to implement them using APIs.
l
References to GoodData in the Portal, error messages, and the Glossary of
the Metric Editor are automatically replaced when the white-labeled
organization is created.
When executing calls to the APIs, use the domain for the white-labeled
environment. For more information about using APIs for white labeling, see
section White Labeling in the GoodData API Documentation.
Tip: To perform calls using https://secure.gooddata.com after
migrating to the white-labeled organization, you must 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
You can white-label the following elements of the GoodData Portal.
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #10
NOTE: Please verify that all assets specified by URL are in
locations that are publicly available on the Internet.
l
Click here to see how customized versions of these elements appear in the
GoodData Portal.
Customizable Mail Elements (under mailSettings)
For more information about specific email templates, see Email Templates.
l
noReplyEmail (required)
Email address from which scheduled reports are sent.
l
registrationEmail (required)
Email address from which registration confirmation emails and
forgotten password emails are sent.
l
invitationEmail (required)
Email address from which project invitation emails are sent.
l
bccEmail (required)
Email address that is blind-copied on invitation emails.
l
supportEmail (required)
Email address to which emails to your customer support are
sent. Address also appears in the body of some emails.
l
supportPhone (required)
Phone number for reaching your customer support. This phone
number appears in email templates.
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #11
UI Elements to Toggle On and Off
l
displayFlashNews (required)
Specify whether to display 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.
l
displayProjects (required)
Specify whether users can select projects on the project picker
menu located in Account > Active Projects. Can be disabled.
l
displayAccountPage (required)
Specify whether users can review their account details on the
Account menu. Can be disabled.
Graphics and Text
l
organizationName (required)
Name of the white-labeled organization on the GoodData
platform. This value is used in the copyright text and in the body
of emails generated by the Portal.
Example: Copyright 2014 <organizationName>, all rights
reserved
Format: string
l
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
l
applicationTitle (required)
Text in the browser title bar or tab title. Also appears on the
registration and login pages.
Example: <My Company> Analytics
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
l
Page #12
faviconUrl
Image that appears in the browser address bar.
Format: 16 x 16, 32 x 32, 48 x 48, or 64 x 64 px; ICO format
l
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
l
applicationBackgroundColor
Specify 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
l
activeColor
Specifies the underline color on active dashboard sections, such
as
Format: HTML color code
l
headerTextColor
Specify a custom color for the text on the dashboard header.
Format: HTML color code
l
headerColor
Specifies a custom color for the dashboard header.
Format: HTML color code
Email Addresses and URLs
NOTE: Please specify fully-qualified or relative URLs.
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
l
Page #13
supportEmail (portalSettings section)
Email address to which tickets are sent when users select Help
> Submit Ticket. Can be disabled.
l
supportForumUrl
URL to which users are directed when they select Help > Visit
Support or click Help in the dashboard footer. Can be disabled.
l
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.
l
documentationUrl
URL to which users are directed when they click the Help link in
the Portal footer or select Help > Documentation. Can be
disabled.
l
securityStatementUrl
URL to which users are directed when they click the Security
Statement link in the Portal footer. Can be disabled.
l
termsOfUseUrl
URL to which users are directed when they click the Terms of
Use link in the Portal footer. Can be disabled.
l
trustUrl
URL to which users are directed when they click the Trust link in
the Portal footer. Can be disabled.
Login and Registration Page Elements
l
brandColor
Narrow strip of color on the top of the Login and Registration
pages.
Format: HTML color code
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
l
Page #14
largeLogourl
Logo that appears on the Login and Registration pages.
Format: 130px maximum height, 470px maximum width,
PNG preferred
l
hideRegistration
Hide the link to the registration form on the Login page. When it
is hidden, users cannot register without being invited.
Sample JSON
The following illustrates the structure of the JSON payload that is submitted to the
white-label API. See section White Labelling in the .GoodData
API Documentation
{
"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"
},
"portalSettings":{
"applicationTitle":"Custom analytics",
"faviconUrl":"/favicon",
"organizationName":"My organization",
"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",
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #15
"headerColor":"#FF0040"
"headerTextColor":"#610B38"
"appleTouchIconUrl":"/icon.png",
"applicationBackgroundColor":"#999",
"hideRegistration":"true | false",
"brandColor":"#999",
"largeLogoUrl":"http://www.example.com/largelogo.jpg"
}
}
}
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #16
How to Request and Customize a New WhiteLabeled Organization
You can remove elements of the GoodData Portal and optionally replace them
with your own branding. This customization is called white labeling. Whitelabeling is applied to a GoodData organization.
NOTE: If your enterprise has multiple GoodData organizations
and you want to apply white-labeling to only one, or if you want
to migrate users between organizations, please contact
GoodData Customer Support.
Key Benefits of White Labeling
l
l
Integrated branding. Deliver your GoodData solution under your own
brand, making the solution a part of your product suite.
GoodData within your domain. Integrate your GoodData solution into your
DNS domain, including a customizable application URL.
What You Can White Label
l
Names: Company names, application names, and even domain names.
l
Logo: Application logos, icons, and favicon.
l
l
l
l
Portal URLs and menus: URLs in the Portal that connect to GoodData
resources, as well as Support, Project, and Account menu items.
Email addresses: Send-from addresses in emails generated from the
Portal.
Selected components and text elements: Some components and text
elements of the Portal can be disabled through white labeling.
Selected skin elements: Some elements of the web page skin can be
styled to align them with your brand.
To see an example of white labeling, click here.
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #17
NOTE: You cannot white label the Portal layout or the format of
emails generated by the Portal.
Pre-requisites: To request white labeling, you must have a valid customer
contract with GoodData Corporation, including licensing of the white-labeling
service. For more information, contact your GoodData Account Manager.
Steps:
1. Gather the following assets:
l
l
l
Choose a URL for the white-labeled organization. For example,
https://analytics.yourcompany.com.
Ask a technical administrator at your company to set up a CNAME and
generate an SSL certificate
Choose an administrator for the new organization.
2. Open a request to create the white-labeled organization at GoodData
Customer Support. Include the following assets, which you gathered in the
previous step, in this request:
l
URL for the white-labeled organization
l
Public and private components of the SSL certificate
l
Confirmation of CNAME creation
l
Email address of the organization administrator
GoodData creates the white-labeled organization. This process typically
takes two weeks.
3. Customize the organization with the GoodData APIs.
Set Up a CNAME and SSL Certificate
NOTE: An IT administrator typically performs these steps.
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #18
Create to the following resources so that GoodData Support can create a whitelabeled organization.
Steps:
1. Define a CNAME record to map the URL for the new white-labeled
organization to secure.gooddata.com. Apply this DNS change within
your domain.
For example, if your white-labeled organization should be accessible from
analytics.example.com, create a CNAME to point from that
destination to secure.gooddata.com.
2. Acquire an SSL Certificate for the new domain. This certificate must have
the following characteristics:
l
In PKCS12 format (preferred)
l
Maps to the CNAME
l
Contains both public and private components
Before you generate the SSL certificate, you must generate a Certificate
Signing Request (CSR) file. This file is required as part of the request to a
certificate authority for issuing a certificate. For more information, see Key
and CSR Generation Instructions.
3. Send both public and private components of the certificate and confirmation
of CNAME creation to the person managing the white-labeling process with
GoodData Customer Support.
Choose an Organization Administrator
l
l
Identify someone to administer your new white-labeled organization.
Typically a member of your IT staff, this person manages users and
customizes and maintains the white-labeled organization using APIs. You
do not need to submit the name of this person with the request to create the
white-labeled organization. However, you should inform them of their new
role and responsibilities, and will work with them to customize the new
organization.
Choose an email address to use as the administrator login for the
white-labeled organization. We recommend using an email alias such as
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #19
admin@yourcomany.com. Using an alias keeps the login consistent and
available if the person administering the white-labeled organization
changes.
Customize the Organization
NOTE: The white-labeled organization is customized using
APIs. If you do not have a technical administrator or developer
who can work with APIs, please contact GoodData
Customer Support.
After the white-labeled organization is created, you can begin to customize it.
Review the list of customization options below and work with your organization
administrator to implement them using APIs.
l
References to GoodData in the Portal, error messages, and the Glossary of
the Metric Editor are automatically replaced when the white-labeled
organization is created.
When executing calls to the APIs, use the domain for the white-labeled
environment. For more information about using APIs for white labeling, see
section White Labeling in the GoodData API Documentation.
Tip: To perform calls using https://secure.gooddata.com after
migrating to the white-labeled organization, you must 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
You can white-label the following elements of the GoodData Portal.
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #20
NOTE: Please verify that all assets specified by URL are in
locations that are publicly available on the Internet.
l
Click here to see how customized versions of these elements appear in the
GoodData Portal.
Customizable Mail Elements (under mailSettings)
For more information about specific email templates, see Email Templates.
l
noReplyEmail (required)
Email address from which scheduled reports are sent.
l
registrationEmail (required)
Email address from which registration confirmation emails and
forgotten password emails are sent.
l
invitationEmail (required)
Email address from which project invitation emails are sent.
l
bccEmail (required)
Email address that is blind-copied on invitation emails.
l
supportEmail (required)
Email address to which emails to your customer support are
sent. Address also appears in the body of some emails.
l
supportPhone (required)
Phone number for reaching your customer support. This phone
number appears in email templates.
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #21
UI Elements to Toggle On and Off
l
displayFlashNews (required)
Specify whether to display 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.
l
displayProjects (required)
Specify whether users can select projects on the project picker
menu located in Account > Active Projects. Can be disabled.
l
displayAccountPage (required)
Specify whether users can review their account details on the
Account menu. Can be disabled.
Graphics and Text
l
organizationName (required)
Name of the white-labeled organization on the GoodData
platform. This value is used in the copyright text and in the body
of emails generated by the Portal.
Example: Copyright 2014 <organizationName>, all rights
reserved
Format: string
l
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
l
applicationTitle (required)
Text in the browser title bar or tab title. Also appears on the
registration and login pages.
Example: <My Company> Analytics
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
l
Page #22
faviconUrl
Image that appears in the browser address bar.
Format: 16 x 16, 32 x 32, 48 x 48, or 64 x 64 px; ICO format
l
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
l
applicationBackgroundColor
Specify 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
l
activeColor
Specifies the underline color on active dashboard sections, such
as
Format: HTML color code
l
headerTextColor
Specify a custom color for the text on the dashboard header.
Format: HTML color code
l
headerColor
Specifies a custom color for the dashboard header.
Format: HTML color code
Email Addresses and URLs
NOTE: Please specify fully-qualified or relative URLs.
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
l
Page #23
supportEmail (portalSettings section)
Email address to which tickets are sent when users select Help
> Submit Ticket. Can be disabled.
l
supportForumUrl
URL to which users are directed when they select Help > Visit
Support or click Help in the dashboard footer. Can be disabled.
l
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.
l
documentationUrl
URL to which users are directed when they click the Help link in
the Portal footer or select Help > Documentation. Can be
disabled.
l
securityStatementUrl
URL to which users are directed when they click the Security
Statement link in the Portal footer. Can be disabled.
l
termsOfUseUrl
URL to which users are directed when they click the Terms of
Use link in the Portal footer. Can be disabled.
l
trustUrl
URL to which users are directed when they click the Trust link in
the Portal footer. Can be disabled.
Login and Registration Page Elements
l
brandColor
Narrow strip of color on the top of the Login and Registration
pages.
Format: HTML color code
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
l
Page #24
largeLogourl
Logo that appears on the Login and Registration pages.
Format: 130px maximum height, 470px maximum width,
PNG preferred
l
hideRegistration
Hide the link to the registration form on the Login page. When it
is hidden, users cannot register without being invited.
Sample JSON
The following illustrates the structure of the JSON payload that is submitted to the
white-label API. See section White Labelling in the .GoodData
API Documentation
{
"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"
},
"portalSettings":{
"applicationTitle":"Custom analytics",
"faviconUrl":"/favicon",
"organizationName":"My organization",
"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",
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #25
"headerColor":"#FF0040"
"headerTextColor":"#610B38"
"appleTouchIconUrl":"/icon.png",
"applicationBackgroundColor":"#999",
"hideRegistration":"true | false",
"brandColor":"#999",
"largeLogoUrl":"http://www.example.com/largelogo.jpg"
}
}
}
Email Templates
Invitation email
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Scheduled report email
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
Page #26
White Label Configuration Guide
Sent dashboard email
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
Page #27
White Label Configuration Guide
Registration email
Password reset email
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
Page #28
White Label Configuration Guide
What You Can White Label
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
Page #29
White Label Configuration Guide
Page #30
Frequently Asked Questions about White
Labeling
Where is my project- and user-specific storage located after I
migrate to the new white-labeled environment?
Project- and user-specific storage remains at secure.gooddata.com.
When I try to log in through the white-labeled URL, I get an
error message "Incorrect username or password.” Why is this?
Your user account is probably not part of the white-labeled domain. Contact
GoodData Customer Support.
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #31
Why does the API for creating a project return the following
error when I use it in a white-labeled organization?
{ "error" : { "parameters" : [], "requestId" :
"n2x3sXZcm6QNj0Hy:xhjses5tbrnxwid8", "component" :
"Projects", "errorClass" : "GDC::Exception::NotFound",
"message" : "Invalid authorizationToken specified. For
troubleshooting, please refer to the on-line documentation
at http://developer.gooddata.com/authorization-tokentroubleshooting" } }
You used the wrong project authorization token. Use the project authorization
token for the white-labeled organization.
When authenticating, my Java application returns this SSL
certificate exception:
javax.net.ssl.SSLException: hostname in certificate didn't
match: !=
The problem is rooted in the Server Name Identification (SNI) technology used to
map multiple SSL certificates to one public IP. To fix, add the following HTTP
header to all requests. This header ensures that the domain and related
hostname are not checked before a response is generated.
X-GDC-CHECK-DOMAIN=false
When I log in to my white-labeled organization, I get an error
that says that my certificate has expired, that I am connecting
to an unsecured site, or that my connection is not private.
The SSL certificate associated with the white-labeled organization has expired.
SSL certificates expire every few years. You must set up a new certirficate.
Steps:
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
White Label Configuration Guide
Page #32
1. Acquire an SSL certificate. For more information about how to do this, see
this topic. GoodData cannot acquire the certificate for you.
2. Open a request with GoodData Customer Support to deploy the
new certificate.
Support deploys the new certificate within ten days.
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.
Copyright © GoodData Corporation 2007 - 2015
All Rights Reserved.