Accessing gray pages for a project

Related Tags: api grey pages

In GoodData, the gray pages are a form-based wrapper on top of the GoodData APIs, which can be used for making changes to an individual project. After you authenticate with the GoodData platform, you can access the gray pages interface using the internal project identifier for your project.

Through a series of gray web forms, you can navigate the various technical-level components of your project to review values and to perform changes as needed.

NOTE: The gray pages are useful if you need to change one or more settings for an individual project when those settings are not available through the GoodData Portal interface.

  • A Word of Caution about the Gray Pages

    The gray pages interface provides technical access to all aspects of a project, including project metadata, the logical data model, and loaded datasets. No data validation is performed within the interface, and many field values are stored as hash values. The potential for damaging a project in the gray pages is significant, and changes cannot be undone.

You should use the gray pages only if you are confident in executing the task, have been provided a specific task to complete through other documentation, or have no other options.

NOTE: Since the gray pages interface applies to a specified individual project, it is not appropriate to use the gray pages to perform batch changes across multiple projects, unless the number of changes and projects is limited.

Project Identifier vs. Project Token

A project identifier is not the same thing as a project token.

  • Project Identifier:
    • A unique 32-character identifier for each project within the GoodData platform
    • Can be found through URL of your project in the GoodData Portal or through the gray pages. Details below.
  • Project Token:
    • A unique hash value that can be used to create projects, often through CloudConnect
    • This value is not available through the GoodData Portal.
    • It is available through the gray pages:
      https://secure.gooddata.com/gdc/projects/{project_ID}/
      
    • You can retrieve both pieces of information through the GoodData Extension Tool for Chrome

Acquiring the Project Identifier

The gray pages for your project are accessed via a specific URL. This URL includes the internal project identifier for your project.

NOTE: You must have access to the project in order to acquire its identifier.

The internal identifier can be acquired in one of the following ways:

  • The project ID is included in any URL for your project in the GoodData Portal. This method is easiest. See Acquiring the project identifier by URL below.
  • The project ID for individual projects can be acquired via GoodData API call. See Acquiring the project identifier via API below.

Acquiring the project identifier by URL

You can use the following steps to acquire the project identifier from the GoodData Portal.

Steps:

  1. Login to the GoodData Portal at https://secure.gooddata.com.
  2. From the Project drop-down, select the project of interest.
  3. The project identifier is included in the URL. Suppose your URL is the following:
    https://secure.gooddata.com/#s=/gdc/projects/njy3r40rc9s4jvrm0y9cqyfghxlo1osu|projectDashboardPage||
    
  4. The project identifier is the following value:
    njy3r40rc9s4jvrm0y9cqyfghxlo1osu
    

Acquiring the project identifier via API

Through the GoodData APIs, you can acquire the list of project identifiers to which you have access.

The GoodData APIs enable developers to submit REST APIs to the GoodData platform, the responses of which contain useful information about your projects in JSON format.

NOTE: Use of the GoodData APIs is considered a developer-level skill.

Below, you can review the basic steps for how to acquire the internal project identifier for a project.

Steps:

  1. Login through the GoodData API. See https://developer.gooddata.com/api#/reference/authentication.
  2. In the returned response, your profile identifier is displayed as the USER-ID value:
    200 (OK)
        Set-Cookie: GDCAuthTT=; path=/gdc; expires=Mon, 30-Jul-2012 09:12:42 GMT; secure; HttpOnly, GDCAuthSST={super-secured-token}; path=/gdc/account; secure; HttpOnly
        Content-Type: application/json
       
    {"userLogin":{"profile":"/gdc/account/profile/USER-ID","state":"/gdc/account/login/USER-ID"}}
    
  3. Your profile ID can also be acquired through the gray pages. Logout of the GoodData Portal, and then login through the GoodData gray pages at the following URL. After login, your profile ID is displayed in the returned set of links:
    https://secure.gooddata.com/gdc
    
  4. Using your profile ID, you can acquire the list of projects to which you have access. To acquire the list of projects, see https://developer.gooddata.com/api#/reference/projects.
  5. In the returned list, search for the display title of your project.
  6. In the URIs listed for the project, you should be able to extract the project identifier. For example, in the links section is the roles name-value pair for the above example project is the following:
    "roles" : "/gdc/projects/njy3r40rc9s4jvrm0y9cqyfghxlo1osu/roles", 
    

Accessing the gray pages

After you have acquired the project identifier, you may access the gray page using the following URL.

NOTE: You must authenticate prior to accessing your project’s gray pages. It may be easier to login through https://secure.gooddata.com.

https://secure.gooddata.com/gdc/projects/{project_id}/

where:

  • project_id corresponds to the internal project identifier that you extracted.

If the returned JSON lists the following properties, which are also returned in the API call that returns the list of projects, you may access any gray page in your project:

Example gray pages for a project

Figure: Gray pages for a project

You may now use the links in this page to navigate to other gray pages for this project. Or you may use URLs that include your project identifier to navigate.