Skip to main content

What is a Project

A project in Bringits Stream UI is a container for organizing and managing your data extraction workflows. Projects serve as the top-level organizational unit that groups together related steps, commands, and configurations. Projects enable you to:
  • Organize workflows by purpose or domain
  • Manage project-level settings
  • Control execution and scheduling at a project level
  • Organize content using Project Groups
Projects are the foundation of your data extraction workflows. Each project can contain multiple steps, and each step contains a sequence of commands called a Blueprint.

Key Concepts

Understanding these core concepts will help you work effectively with Bringits Stream projects:

Projects

Projects are containers that hold your complete data extraction workflow. They include:
  • Project-level configuration (name, type, project group, advanced settings)
  • Organization through Project Groups
  • Execution control and scheduling

Steps

A step is a self-contained unit within a project that executes a sequence of commands (called a Blueprint). Each step:
  • Runs synchronously - commands execute one after another
  • Passes output from one command to the next
  • Can be configured with its own interval (repeatable) settings
  • Has a Technology Used setting (HTTP, Browser, etc.) that determines available commands
  • Includes Miss Tolerance and other advanced settings
  • Represents a specific task in your data extraction workflow

Commands

Commands are the building blocks of a Blueprint. Each command:
  • Performs a single specific operation
  • Executes synchronously in sequence
  • Chains output to the next command
  • Supports various operations (HTTP requests, browser automation, DOM manipulation, data parsing)

Blueprints

A Blueprint is the sequence of commands within a step. Commands in a Blueprint execute sequentially, with each command’s output available to subsequent commands.

Sinks

Sinks deliver your extracted data to a destination. A sink is a Sink command you add inside a step’s Blueprint, usually as the last command of the last step:
  • RabbitMQ, Kafka, S3 and MongoDB: delivered through your organization’s sink configuration
  • Managed Bucket: written to the Bringits-managed bucket, no configuration needed

Placeholders

Any command parameter can contain ${name} placeholders. Just before each command runs, Stream replaces them with values from: If item state and a local variable share a name, the item state value wins. A placeholder with no matching value is left as literal text.
Placeholders are resolved before the command executes. Make sure an earlier step or command produces the value before you reference it.
Related mechanisms:
  • Parallel requests: HTTP Parallel Request fills $(name) placeholders from each value in httpParams.
  • Generated values: use Generate commands for dates, numeric sequences and UUIDs.
  • Credentials: sink credentials are stored, encrypted, in your organization’s sink configuration rather than in commands.

Project Organization

Projects can be organized using Project Groups for easier management:

Project Groups

Project Groups help you organize related projects together. Groups are created and managed from the Groups section in the main sidebar. Each group has:
  • Group Name - A descriptive name for the group
  • Description - Details about the group’s purpose
  • Members - Team members assigned to the group
You can assign a project to a group using the Project Group dropdown in the Project Settings panel.

Tags

Projects in the list view display tags for quick identification. Tags help you filter and categorize projects by:
  • Purpose or use case
  • Technology type (Real time, HTTP, etc.)
  • Status (Active, Inactive)

Ownership

Projects display ownership (Creator) and organizational structure, allowing team members to access relevant projects based on permissions. This helps maintain proper access control and project organization.

How Components Work Together

Understanding the relationship between projects, steps, commands, and sinks:
Each result a step writes to children becomes an item for the next step, which runs once per item. Sink commands deliver data from whichever step they are placed in.

Next Steps

Now that you understand the key concepts, you’re ready to create your first project.