Tools

GoodData provides a variety of clients and interfaces for interacting with your projects and their underlying technical objects.

Building Projects

CloudConnect Designer

For the ETL developer, CloudConnect Designer is the primary tool for rapidly assembling ETL graphs and deploying them to your projects. When this Java-based desktop application is downloaded and installed, you can immediately begin building ETL graphs through a drag-and-drop interface. When you have finished building and testing your graph, you can publish it directly to one or more projects in the GoodData platform through the CloudConnect Designer interface.

Integrated into CloudConnect Designer is the LDM Modeler, a graphical interface for building the logical data models for your projects.

To get started with CloudConnect Designer:

  • Download: Use the link to acquire the software.
  • Project Authorization Token: In order to create new projects in the GoodData platform, you need a project authorization token, which you use in CloudConnect Designer to create new, empty projects. See GoodData Evaluation Program.
  • Documentation: CloudConnect Designer User Manual

CloudConnect LDM Modeler

Integrated into CloudConnect Designer, the LDM Modeler tool is used to rapidly assemble the logical data models for your project. In GoodData, a logical data model represents the fields and datasets of your GoodData project and their relationships. Through a drag-and-drop interface, you can build datasets, populate them with fields, and create the connections that enable flexible reporting within your projects. Your LDMs can be published to one or more projects directly through the interface.

In GoodData, data modelers do not need to create the physical tables and relationships within the datastore. This physical data model is automatically created by the GoodData platform based on the LDM that you publish to the project.

To get started with CloudConnect LDM Modeler:

  • Download: If you have already downloaded and installed CloudConnect Designer, you are ready to use LDM Modeler.
  • Documentation: CloudConnect LDM Modeler Guide

GoodData Portal

For assembling the metrics, reports, and dashboards in your GoodData projects, the best interface to use is the GoodData Portal. After you login and select your project, you can begin building the metrics that are used in your reports and add and configure the reports that appear in the dashboards available to all project users. The tools to build are available through the same interface as the tools used to experience your created reports.

To get started with the GoodData Portal:

Agile Data Warehousing Service

Built on top of a leading-edge columnar database technology, Agile Data Warehousing Service (Data Warehouse) can store enterprise data directly from the source, enabling you to manage snapshots of your data as close to the source as possible. After data has been captured into Data Warehouse, you can use standard SQL queries to perform inside the database any manipulations required of your ETL processes. In-database modifications greatly accelerate the overall process, turning ETL into ELT. When you are ready to load your project, a two-step process extracts the data from Data Warehouse and loads it into the specified project.

NOTE: For more information about using Data Warehouse, please contact GoodData Account Management.

Multi-Dimension Analytics Query Language (MAQL)

MAQL is the querying language used to generate metrics from the project's datastore. In most cases, metrics can be built through the GoodData Portal wizard-based interface. The output of these metrics is typically a single MAQL SELECT statement.

For more complex calculations, you may need to learn how to build custom queries using MAQL syntax. Through the Advanced Metric Editor, you can manually build MAQL SELECT statements and chain them together to assemble sophisticated metrics.

This version of MAQL is MAQL DQL (Data Querying Language). The other version of MAQL, DDL (Data Definition Language), is used to specify the logical data model for the project. In most cases, MAQL DDL statements are defined and submitted through the LDM Modeler in CloudConnect Designer.

To get started with MAQL DQL:

User-Specific Storage

When you are ready to deploy ETL processes to multiple projects, you can use user-specific storage to upload your CloudConnect projects and then reference the appropriate GoodData APIs to provision the processes to the designated projects. Access to this area is limited to only the designated use.

Project-specific storage is available only for a few hours, after which it is automatically cleared by the platform.

To get started with User-Specific Storage:

Visualization SDK

Use the Visualization SDK to extend your project visualizations in new directions. This library provides a Javascript wrapper on top of the GoodData APIs, so that you can manage authentication and data retrieval with a few simple calls. Insert the results into your custom visualizations and then integrate the visualizations as web content into your dashboards.

NOTE: Visualizations and their projects must be hosted within the same domain, as the GoodData APIs prevent cross-domain queries. So, the Visualization SDK may be used in white-labeled organizations only without special modifications. For non-white labeled customers, a separate GoodData organization (domain) must be created to host visualizations and the projects that reference them. For more information on acquiring a new domain, please contact Account Management.

To get started using the Visualization SDK:

Maintaining Projects

Project-Specific Storage

Project-specific storage is available for reference during the execution of your ETL graphs. For example, you may use project-specific storage to stage your source data files prior to ETL execution.

To get started with Project-Specific Storage:

CloudConnect Data Integration Console

Use the Data Integration Console to manage and monitor your ETL processes across multiple projects. Define schedules through a simple interface, and build notifications triggered on events of the schedule. As needed, you can execute ETL processes on an ad-hoc basis, download processes for continued development in CloudConnect, or deploy them right back into one or more projects. DIC supports batch management of some actions across multiple processes.

Data Integration Console maintains a history of process executions, so you can review execution time, logs, and other details related to your ETL environment.

To get started with Data Integration Console:

CloudConnect Data Loading Administration

NOTE: CloudConnect Data Loading Administration has been superseded by Data Integration Console. DLA will be available until September 2014, after which it will no longer be accessible.

After you have deployed ETL graphs to your projects, you can use the CloudConnect Data Loading Administration console to manage the scheduled execution of your graphs and monitor their progress. Through a simple web interface, project administrators can configure ETL schedules, including specification of project parameters, and execute graphs on an ad-hoc basis. When notifications are defined for the schedules, stakeholders can be informed when executions succeed, fail, or reach other execution results.

CloudConnect Data Loading Administration maintains a history of process executions, so you can review execution time, logs, and other details related to your ETL environment.

To get started with Data Loading Administration:

GoodData Provisioning Scripts

GoodData provides a set of scripts that can be customized to provision users and projects across your GoodData organization. If you are responsible for building or maintaining a large number of projects, you will want to develop the mechanisms for managing this user and project environment. These Perl-based scripts provide the basis for managing the most common add, edit, and delete operations through the GoodData APIs. With some customization, you can gain command over the most common project administration tasks.

To get started with the provisioning scripts:

Platform Interfaces

GoodData REST APIs

The GoodData REST APIs enable developers to programmatically interact with all aspects of their GoodData organization. User, project, and ETL provisioning can be managed through these structured APIs. Additionally, you can modify individual objects within your project, such as metrics, reports, dashboards, Data Permissions filters, and the logical data model.

To get started with GoodData REST APIs:

Automation SDK

Utilize Ruby's efficient scripting capabilities to leverage BI automation in the GoodData platform. The Automation SDK library provides a powerful library on top of the GoodData APIs. Using familiar tools, developers can build and execute scripts to automate many common GoodData tasks, such as creating new projects, managing deployment of individual dashboards, reports, and metrics, and building user communities. Best practices are embedded in the SDK, so your Ruby building blocks can be rapidly assembled in a few lines of code, enabling centralization of your code base, standardization, and efficient use of your time.

To get started using the Automation SDK:

Gray Pages

For making small changes to the technical definition of your deployed projects, developers can utilize the gray pages, a form-based interface. By selecting links displayed in the gray pages, you can navigate the internals of your project definition and use the available form fields to submit changes at the endpoints.

NOTE: The gray pages should not be used for most interactions with your projects, as effective navigation requires an understanding of the technical layout of a project definition and management of the internal identifiers of your project. GoodData recommends using other interfaces where possible.

NOTE: If you are using Google Chrome, the GoodData Extension Tool provides links into the gray pages to simplify navigation from the current project in the GoodData Portal.

To get started with the gray pages:

GoodData Extension Tool for Chrome

In your local instance of the Google Chrome browser, you can install the GoodData Extension Tool, which enables faster access to the gray pages. When you are an administrator of a GoodData project displayed in the current browser tab, you can click the GoodData icon that appears in the address bar. A set of links to the gray pages for the current project is displayed, enabling you to immediately jump to the appropriate page to review and modify project metadata objects, the logical data model, ETL graphs and more, as well as perform exports and imports from the browser window.

NOTE: The gray pages should not be used for most interactions with your projects, as effective navigation requires an understanding of the technical layout of a project definition and management of the internal identifiers of your project. GoodData recommends using other interfaces where possible.

To get started with GoodData Extension Tool:

  1. Download: Download link and instructions are available through the Documentation page.
  2. Documentation: GoodData Extension Tool for Chrome

CL Tool

Prior to the development of CloudConnect Designer, GoodData developers utilized this command-line tool to manage the development and publication of ETL graphs and the logical data model. This tool is available in Ruby and Perl implementations.

NOTE: The CL Tool is a legacy interface. Unless you have already learned to use this tool, you should invest in learning how to use CloudConnect Designer and the GoodData REST APIs instead. The CL Tool may be deprecated in a future release.