Prerequisites:
- Access to Bringits Stream UI
- Organization dashboard access
- Understanding of key concepts (projects, steps, commands, variables)
Creating a New Project
Accessing Bringits Stream UI
1
Open Bringits Stream UI
Access the Bringits Stream UI from your organization’s dashboard or navigate directly using the provided Bringits Stream URL.
2
Navigate to Projects
From the main sidebar menu, select “Projects” to display the Projects list with existing projects and their details.
3
Create New Project
Click “Create new project +” located in the upper-right corner of the Projects page.
Project Creation Dialog
When you click “Create new project +”, a dialog appears with two options:
After entering a project name and clicking “Create”, you’ll be taken to the project editor where you can configure additional settings.
Project Settings
Once your project is created, you can configure it using the Project Settings panel on the right side of the editor.Basic Settings
Advanced Settings
Expand the Advanced Settings section to access:Project Groups
Projects can be organized using Project Groups. Groups are managed separately from the Groups section in the sidebar, where you can create groups with a name, description, and assign members.Project Groups help manage large numbers of projects. Consider creating groups by team, use case, or project type.
Placeholders
Commands reference values from item state, local variables and the current run with${name} placeholders. See Placeholders.
Creating Your First Step
Adding a Step
Within your project’s Scraping flow tab, you’ll see the workflow canvas. To add a new step:1
Click the Plus Button
Click the ”+” button below the existing step (or in the empty canvas for new projects) to add a new step.
2
Configure Step Settings
When a step is selected, the Step Configuration panel appears on the right side. Configure the required fields.
Step Configuration Fields
Repeatable Settings
When Repeatable is enabled, configure the interval:- Manual interval - Set a specific interval value in seconds
- Smart interval - Let the system optimize the execution schedule
Step Advanced Settings
Expand the Advanced Settings section within step configuration to access:Limits Checked on Save
When you save or import a project, Stream rejects the configuration if any step breaks these rules:
Commands allowed per technology: every step can use Parse, Sink, Validation, Generate and Execution Flow commands. In addition, HTTP steps use HTTP commands; Browser steps use Browser and Interaction commands and need at least one of them; WebSocket steps use WebSocket commands; Android steps use Android and Browser commands.
Adding Commands to Your Step
Command Categories
The left sidebar displays available command categories that you can drag into your step:- Android - Mobile automation commands
- Browser - Web browser automation (open, click, navigate)
- Execution_flow - Flow control commands
- Generate - Data generation commands
- HTTP - HTTP request commands
- Interaction - User interaction simulation
- Parse - Data parsing and extraction
- Sink - Output destination commands
- Validation - Data validation commands
- Ws - WebSocket commands
Adding a Command
Click on a command in the left sidebar to expand its options, then drag or click to add it to your step. Alternatively, use the Tool Center button within the step to browse and add commands.HTTP Command Configuration
When you add an HTTP command and select it, the HTTP Command panel appears with these options:Each command has an info icon (ℹ️) that explains its purpose, available parameters, and usage examples.
Example: Parse and Browser Commands
Every command in a Blueprint is an object withid, type and params.
Json Path
Extracts data from JSON responses using JSONPath expressions. Writing tochildren turns each match into an item for the next step:
Get Text Contents
Retrieves text content from DOM elements:- CSS Selectors - Target elements using standard selectors
- Filtering - Filter by innerText, hasChildren, or index
- Chained Locators - Use
continueWithfor nested searches - Returns Array - Text content from all matching elements
Get Attributes
Extracts attributes from DOM elements for detailed scraping operations:Connecting a Sink
Supported Sink Types
Sink commands deliver a step’s results to your destination. Stream supports RabbitMQ, Kafka, S3, MongoDB and the Managed Bucket. RabbitMQ, Kafka, S3 and MongoDB deliver through your organization’s sink configuration, which holds the connection credentials.Configuring a Sink
1
Add a Sink Command
From the Sink category in the left sidebar, drag the sink command for your destination into your step. Typically, this is the final command in the last step of your workflow.
2
Configure the Destination
Select the sink command and set its destination, for example the exchange name, exchange type and routing key for RabbitMQ, or the topic for Kafka.
3
Verify Delivery
Run the step from its test panel, then confirm the data arrives at your destination.
Sinking does not replace the normal flow: the step’s results are still processed into items, so child steps and miss tolerance keep working.
Running Your Project
Activating the Project
1
Save Configuration
Click “Save project” in the top-right corner to save all steps and commands.
2
Activate Project
Toggle the project status from “Inactive” to “Active” using the status toggle in the project header.
3
Monitor Execution
The system begins executing steps based on configured intervals. Monitor the execution to verify proper operation.
- Repeatable steps run on their interval; the root step is always repeatable
- Child steps run once per item produced by their parent step, with the parent item’s state available as
${name}placeholders - Placeholders are resolved before each command executes
- Automatic scheduling - No manual triggering required once active
Testing and Debugging Your Project
For comprehensive testing and debugging guidance, see the Debugging Your Project guide.The Bringits Stream ecosystem includes debugging tools and sandbox environments for testing projects before production deployment.
Next Steps
Now that you’ve created your first project, explore:- Debugging Your Project - Learn testing and troubleshooting techniques
- Monitor Your Stream - Track project performance
- HTTP Commands - Deep dive into HTTP request configuration
- Browser Commands - Web automation capabilities
- Parse Commands - Data extraction techniques