How to Use a Brick

Before you deploy a brick, we recommend that you familiarize yourself with its prerequisites, expected format of the input data, parameters, and other related information. To do so, navigate to the corresponding section under Bricks.

Contents:

How to Use a Brick

The process of using a brick consists of the following steps:

  1. Deploy a process for the brick (see Deploy a Data Loading Process for a Data Pipeline Brick).

    Add Data Sources to the deployed process to be able to reference their parameters in the process schedule later. For more information, see Reuse Parameters in Multiple Data Loading Processes.

  2. Schedule the deployed process (see Schedule a Data Load).
    When scheduling:

    • Make sure that you are scheduling a brick as a domain admin.
      For example, the release brick (see Release Brick) needs permissions to create the segments, and the provisioning brick (see Provisioning Brick) needs permissions to copy the content from the master workspaces to the newly created client workspaces.
    • Add parameters. For the list of parameters for the brick, navigate to the corresponding section under Bricks.

      Some parameters are easy to specify (require a simple string or a choice of true/false) while the others may require complex structures. For more details, see Specifying Complex Parameters.

      If you are scheduling a process with Data Sources connected to it, you can reference the parameters from those Data Sources instead of entering explicit values. For more information, see Reuse Parameters in Multiple Data Loading Processes.

    • For the release brick (see Release Brick) and the rollout brick (see Rollout Brick), set the frequency of execution to manually.
  3. Whenever needed, run the schedule outside of the schedule (check Run a Scheduled Data Loading Process on Demand).
    Before running the schedule, make sure that you are logged in as a domain admin.

The LCM bricks that were deployed via the Appstore are deprecated and no longer supported. Only major security fixes will be available, if needed.

The bricks that are already deployed will continue working until further announcement. If you have LCM bricks deployed on your site from Appstore and want to migrate to the bricks that are deployed as a regular process with the Data Integration Console, contact GoodData Support.

Workspaces to Deploy Bricks

You have to deploy bricks to a service workspace. The service workspace is a workspace that is used for running bricks at the domain level. The service workspace does not have to contain any data. It is usually a dummy workspace that is used only for deploying bricks in it. You have to be a domain administrator to run a brick at the domain level.

Exceptionally, you can deploy the Users Brick also to a segment's master workspace (to manage users within the corresponding segment) or a client's workspace (to manage users within this particular workspace). You have to be a workspace administrator to run a brick at the workspace level.

Brick Process Owner

The user under whom the brick is executed depends on how the brick execution is started.

  • When the brick is run automatically based on the schedule, it is executed under the user who deployed the brick (specified in 'Executes under' in the brick schedule).
  • When the brick is run on-demand, it is executed under the user who ran the brick on demand (see Run a Scheduled Data Loading Process on Demand).
  • When the brick is run via the API, it is executed under the user who submitted the API call.
Powered by Atlassian Confluence and Scroll Viewport.