GoodData Extension Tool for Chrome

Related Tags: integration data loading

The GoodData Extension Tool for Chrome provides GoodData project developers access to the technical resources (“gray pages”) with definitions of their projects. Through these resources, you can make changes to the underlying technical specifications of key project elements, such as the logical data model, reports, dashboards, and ETL processes. The Extension Tool also connects developers to interfaces for querying the project datastore, browsing project-specific storage, applying changes through MAQL, and managing data loading processes.

  • The GoodData Extension Tool works out of the box for standard GoodData organizations, and it can be easily configured to work also on white-labeled portals running GoodData.

NOTE: Some of the functions of the toolbar are available only when you are accessing GoodData projects to which you have been assigned the Administrator role.

NOTE: The GoodData Extension Tool is available for the Google Chrome browser only.

Installation

The GoodData Extension Tool for Chrome is available for download in the Chrome Web Store. For more information, please visit GoodData Extension Tool download.

NOTE: When installing or updating the plugin, please grant it access to all pages. This permission is requested due to support for white-labeled portals that can have different domain name.

Usage

Since the GoodData Extension Tool provides access to the runtime technical definition of your project, there are several things that you should consider while using the tool:

NOTE: This tool (and the gray pages linked from it) is suitable for making changes to a single project. If you need to apply changes across multiple projects, the better approach is to use the GoodData APIs. For more information, see API Documentation Portal.

  • A Word of Caution

    The interfaces available through the GoodData Extension tool provide technical access to all areas of a project, including project metadata, the logical data model, and loaded datasets. No data validation is performed within these interfaces, and many field values are stored as hash values. The potential for damaging a project is significant, and in most cases, the changes cannot be undone. Where possible, use CloudConnect Designer or the GoodData Portal for interacting with your projects.

Accessing

After the GoodData Extension Tool has been installed in your browser, you can access the toolbar whenever you visit a GoodData project. Click the GoodData icon to open the toolbar:

GD Chrome Plugin
Figure: GoodData Extension Tool for Chrome

NOTE: Some options are available depending of the context (e.g. within GoodData project).

NOTE: The Extension Tool itself does not do any changes to the project. It only provides links to resources and gathers informations form GoodData APIs with non-destructive calls.

Overview of Interfaces

The following interfaces are available through the Extension Tool.

GoodData Portal

The GoodData Portal is the web application through which you access your projects. When the Extension Tool is installed in your Chrome browser, it is available whenever you are viewing a project in the GoodData Portal.

Gray Pages

The gray pages are a form-based web interface for interacting with the technical definition of any project. The interface enables you to review technical definitions and, in some cases, to make changes to those definitions. The gray pages is basically a simple UI over GoodData API.

NOTE: No data validation is performed in the gray pages.

For more information, see Accessing Gray Pages for a Project.

GoodData Storage

GoodData Storage provides project-specific data storage, which can be used for staging your data files for your ETL graphs. Each GoodData project has a storage segment reserved for it. This space is accessed transparently to the user by the platform during operations.

Tools

The following tools are available in the toolbar.

GD logo

Click the GD logo to return to the currently selected dashboard for the project in the GoodData Portal.

  • If no dashboard is selected, you may be required to select the project again.

New

Creates a new project for which you are the Administrator and sole member. Fields:

Field Name Description
TitleEnter a descriptive title for the project. This value appears in the Projects drop-down menu.
SummaryProvide a brief description of the content, scope, and users of the project.
TemplateIf the project is being created from a template, please provide the URI to the project template otherwise keep blank.
Authorization TokenTo create a project, you must provide a valid authorization token. For more information on acquiring a temporary authorization token, see Request Token.
Guided NavigationPlease select the Use guided navigation checkbox. This option prevents users from building reports from incompatible attributes and metrics.
EngineUnless explicitly told to do otherwise, you should use the default database engine.

To create the specified project, click Submit.

List

Lists all projects to which you have any access level.

Obj

NOTE:This link is only available if you are accessing some object in UI or gray pages.

Opens the gray page for the currently selected object for:

  • Dashboards
  • Reports
  • Attributes, Facts, and Metrics

If you are in the gray pages, you can use this link to access the currently displayed object from within the project in the GoodData Portal.

NOTE:Users are defined within the scope of the GoodData organization, so their technical definitions are not accessible through the project definition.

ObjEX

NOTE:This option is available only when viewing a report object.

Opens the diagram explaining the calculation of the last saved version of the current report.

With the new version of GoodData Extension Tool, the results of this query are formatted for easier orientation.

  • There are tooltips for the object identifiers to show object titles, color-coded as in metric editor (metrics are green, and attributes are violet).
  • Click an object to open its specific gray page.

Colorized identifiers with tooltip in explain resource

Figure: Colorized identifiers with tooltips for the explain resource

Project

Opens the top-level gray page for the current project.

MD

Opens the gray page for the project metadata. A project’s metadata includes all metrics, reports, and dashboards that have been built or imported into the project. This interface also provides access to the logical data model, project template, and other objects that have been created or referenced in the project.

Query

Opens the Query gray page, containing options to execute queries against the project datastore. Executed queries return references to attributes, facts, Data Permissions (userfilters), and more.

LDM

Opens the logical data model diagram that is generated within the GoodData Portal.

  • This option is also available from the Manage Page in the GoodData Portal.

LDMLAB

Opens logical data model in experimental interactive browser.

NOTE:This option only works when you are administrator in the GoodData project.

Mng

Use this screen to execute MAQL DDL commands to update your logical data model for the current project.

NOTE:Through the Mng option, you can access the Manage2 interface for your project. This interface allows you to make direct changes to the logical data model using MAQL DDL statements. Any changes applied through this interface are stored in the runtime version of the logical data model only. If your project is updated from a CloudConnect project, the changes you made through this interface may be overwritten by the contents of the CloudConnect project, which can cause cascading deletions throughout the project. Where possible, use CloudConnect to update the LDM of your project.

NOTE:Before you execute any changes, please verify that you have selected the correct project first.

Valid

Performs a technical validation of your current project, checking the project objects for the selected options.

Exp

The Exp option performs a full export of your project from the platform datastore.

When the export is executed, please retain the generated token for use during import.

NOTE:The user who created the export is always included as an administrator.

NOTE:Export tokens are valid for about 24 hours.

Options:

Field Name Description
Export UsersSelect the include users checkbox if you wish to export the users referenced in the project.

NOTE: When the exported project is imported into a new project, all included users have immediate access through the Projects drop-down menu in the GoodData Portal or through other interfaces to which they have access.

Export DataSelect the include data checkbox to include the project’s datasets as part of the export.
Authorized UsersEnter a newline-separated list of GoodData usernames of the users to which you wish to grant access to the exported project.

ExpMD

The Exp MD option performs a partial metadata export of your project that can be later used for importing to another project.

When the export is executed, please retain the generated token for use during import.

Options:

Field Name Description
Export ObjectsEnter a newline separated list of GoodData object URLs that you wish to export from the project. Object URL looks like /gdc/md/PROJECT_ID/obj/OBJ_ID and you can either get this from the URLs or use the Query link to locate those IDs.

NOTE: An export is performed in cascade - i.e. exporting dashboard will also export all reports and metrics used on that dashboard, exporting a report will also export all metrics used in it.

NOTE: Dashboard tabs are not separate objects. All tabs will be exported with a dashboard.

Imp

Performs a full import of an exported project into the currently selected project.

NOTE: A full import can be only performed on empty (new) project by an administrator. To perform changes to existing project use either CloudConnect to change LDM or partial metadata export/import to migrate reports, metrics and dashboards.

To perform the import, insert the token for the full export in the Import token textbox. Then, click Submit.

ImpMD

The Imp MD option performs a partial metadata import of previously exported objects.

To perform the import, insert the token for the partial metadata export in the Import token textbox. Then, click Submit.

Keep the checkboxes as they are. Different modes are not supported yet.

NOTE: An import will overwrite all objects that are imported in the target project. Note that objects are exported in cascade - i.e. exporting dashboard will also export all reports and metrics used on that dashboard.

NOTE: Make sure that the data model is the same for both projects (or at least the same for the exported part). Partial MD export will not do any changes to the data model. If the change is needed this needs to be done prior to the import using CloudConnect, LDM API or MAQL.

Data

Provides access to the project-specific storage for the current project. To access, a project must be open in the GoodData Portal to which you have administrator access.

To access, please enter your GoodData Portal credentials in the displayed dialog. Click Login.

This WebDAV area is typically used for staging files during the ETL processes for the project. Storage in this area is governed by the ETL graph, as defined through CloudConnect Designer.

The displayed list shows the uploads that have been performed to project-specific storage.

NOTE:Project-specific storage is purged on a periodic basis. It should not be considered permanent storage.

ETL

For the currently selected project, you can use this interface to review and deploy ETL processes.

NOTE: For deploying ETL processes, you should use CloudConnect Designer to publish them to projects and use the Data Integration Console to manage them. For more information, see Schedule and manage data loading process.

Sch

Display schedules of currently selected project in Data Integration Console.

SchGP

For the currently selected project, display a resource in grey pages with list of schedules.

NOTE: For scheduling ETL processes, you should use use the CloudConnect Data Loading Administration Console to manage them. For more information, see Schedule and manage data loading process.

i icon

Displays basic information about the current project. Fields:

  • Hover the mouse over any Approximate date value to see the exact date and time, as returned by the GoodData API call.
Field Name Description
CreatedApproximate date project was created.
UpdatedApproximate date project was last updated.
DB driverName of database driver
Time ZoneCurrent project Time Zone used for Date Macros such as {THIS}.
Click to change it.
More information is in article Setting a Custom Time Zone for Your Project.
Last data loadApproximate date of last successful data load of any dataset
Last sched. ETLApproximate date and results of last scheduled data load.
Click the status message to open the execution log for this run if available.
Next sched. ETLApproximate date of next scheduled data load
TokenProject authorization token used to create the project

+ icon

Use this option to customize the Extension Tool. In the available options, you can customize the icons used in the toolbar. For example, you may wish to identify individual projects or hostnames by specific icon, so that you can quick identify the current project where you are making changes.

NOTE: You may only choose from a predefined set of icons.

You may also disable the parsing of CloudConnect logs. On slower machines, performance may be impacted when processing longer logs with color formatting. Or, if the log file format changes, the log parsing can be disabled until the issue is rectified. For more information, see CloudConnect log file parsing.

You may also use the hostname options for applying the Extension Tool to white-labeled domains.

It is possible to add one custom button to the Extension Bar.

Field Description
Title What to display in the bar (up to 6 characters)
Popup A popup label is displayed when hovering over the title
Link Destination when the link is selected. You can use following placeholders:
${SERVER} - hostname of current server
${PID} - project identifier of current project
${OBJ} - object identifier of current object

Example: https://${SERVER}/gdc/md/${PID}/validate

CloudConnect log file parsing

When log file parsing is enabled, it is automatically executed whenever your browser contacts a CloudConnect *.log file in the GoodData platform. These files are generated when graphs are executed in the GoodData platform.

NOTE: Generally speaking, parsing is fairly fast for files up to 50MB. If your file is larger, you can append the URL with #no_parse to disable parsing or disable the parsing permanently in the options.

When a log file is accessed, the following panel is displayed:

CloudConnect log file parser for Extension Tool
Figure: CloudConnect graph execution

Label Description
Name of graph The filename of the graph that was executed
Calculated elapsed time The elapsed time of the graph run
Detect errors When errors are detected, the view will scroll to the first one automatically. To download the entire directory when an error occurs, click Download data.
RequestID Click to display request identifier information. By default, this information is present on each row of the log file but the parser hides it to make the log more readable. RequestID is useful when you are requesting help from GoodData support.
Get Data In case of failed execution, download whole directory with data and graph to debug. The link is valid for about 24 hours.
Refresh Refresh the log with the same settings of loglevels enabled.
Refresh [checkbox] Refresh the log automatically every 5 minutes. When the execution finishes and the log window is not active (but still open) you will be notified with desktop notification. Click the notification to see the log again.
WatchDog,
DEBUG,
INFO,
WARN,
ERROR
Use these settings to toggle display of color-coded log levels and the WatchDog (a monitoring process showing what is being done every few seconds).

Log files are parsed according to the following color-coded scheme:

  • To display the log file without color formatting, click the X in the upper-right corner of the displayed panel.
color code log level
light blue on white debug
black on white info
black on orange warn
black on light red error
gray on white WatchDog (monitoring process)

? icon

Opens help within the Extension tool.

DL icon

Opens the Data Integration Console on its main page. For more information, see Data Integration Console.