How to Use a Brick

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).

  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.

    • 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.

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.