Getting Started with Pipelines in Bureau Works
Overview
The Pipelines feature in Bureau Works enables you to automate and customize your project workflows. Pipelines can automate actions such as updating project status or skipping tasks based on specific conditions, providing flexibility and efficiency to your processes.
Index
What Are Pipelines?
Where to Find Pipelines
Actions: The Core of Every Pipeline
How Pipelines Are Configured (YAML)
Creating a Pipeline: Required Information
What Are Secrets?
1. What Are Pipelines?
Pipelines are automated workflows that allow you to define what should happen in your projects and when.
With Pipelines, you can:
Automatically update the status of a project or task
Skip specific steps when certain conditions are met
Trigger actions based on events, such as task delivery or project completion
These automations help reduce manual work and minimize errors, giving you greater control over your workflow.
2. Where to Find Pipelines
You can access Pipelines in the Bureau Works platform by navigating to:
Settings
Automation Settings
Pipelines
You will also find a section called Secrets here, which is explained later in this article.
3. Actions: The Core of Every Pipeline
Actions are the building blocks that define what a pipeline actually does. Each step in your pipeline is an Action—whether you are checking for manual edits, updating a workflow status, sending an HTTP request, or logging information.
Some commonly used actions include:
bw_check_manual_edits:
Checks if any manual changes were made to a task or segment, and provides a result you can use as a condition in your pipeline.bw_check_comments:
Verifies if there are comments present in specific channels or workflow steps—useful for triggering follow-up actions only when discussion or feedback is present.bw_update_workflow:
Updates the status of workflows or tasks automatically based on your conditions.bw_debug_action:
Logs details for troubleshooting or monitoring your automations.
A pipeline can combine several Actions in sequence to achieve even complex automations.
By choosing and configuring the right Actions, you ensure your workflow is as efficient and tailored as possible.
4. How Pipelines Are Configured (YAML)
Pipelines are configured using a YAML file. YAML is a structured text format that defines the logic and sequence of your automation, including the Actions to be performed.
Example Configuration: Below is an example of a YAML configuration for a pipeline.
Scenario:
If any segment in the Review step of a project is manually edited, the next step (“Review 2”) remains open for the linguist to continue. If there are no manual edits in Review, the “Review 2” step is automatically skipped.
name: monitor-work-unit-delivery
on: [WORK_UNIT_STATUS_CHANGE]
run:
- name: check-work-unit-manual-edits
action: bw_check_manual_edits
id: job1
condition: event.details.new_status == 'DELIVERED' && (event.details.org_unit_uuid == 'orgUnitUUID')
with:
workflows:
- workflowUUID # Review
- name: update-workflow-job
action: bw_update_workflow
id: job2
condition: event.details.new_status == 'DELIVERED' && !job1.has_manual_edits && (event.details.org_unit_uuid == 'orgUnitUUID')
with:
workflows: []
update_workflows:
- workflowUUID # Review 2
update_task_status: SKIPPED
update_work_unit_status: SKIPPED
update_tasks: true
same_language_workflows: true
same_file_workflows: true
- name: debug
action: bw_debug_action
id: debug_job
with:
debug: 'Resolve the following message: Event ID: ${{ event.details.id }} and job1.has_manual_edits: ${{ job1.has_manual_edits }} and event.details.org_unit_uuid: ${{ event.details.org_unit_uuid }}'
Note:
The required workflow UUIDs can be found in the platform under Translation Settings > Workflows.
5. Creating a Pipeline: Required Information
To create a new pipeline, you will need to provide the following information:
Pipeline Name: A unique name for your pipeline.
Description: A brief summary of what your pipeline is designed to do.
YAML Configuration: The logic and steps of your automation, written in YAML format as shown in the previous section.
After entering this information, save your pipeline. It will then be available and will execute automatically according to the events and logic you have defined.
6. What Are Secrets?
Secrets are used to securely store sensitive information such as passwords or API keys that your pipelines may require.
Secrets are encrypted and only accessible by the automations you authorize.
You can manage secrets in the Secrets tab within the Pipelines area.
