Workflows

Workflows let you connect multiple Bright operations into a reusable execution flow. Instead of configuring and running each operation separately, you can define the flow once and run it manually or on a schedule.

A workflow can include:

• A trigger that determines when the workflow starts and how many times it should repeat
• A Discovery
• A Scan

Scopes

To activate and manage workflows, you should have the following scopes :

• workflows
• workflows:delete
• workflows:manage
• workflows:read
• workflows:run

Create a workflow

1. From a project view, go to Task Activity -> workflows
2. Select Create workflow.
3. Enter a name for the workflow.
4. From the right side, you will be required to select a trigger:

   1. Manual trigger

      Select Manual when you want users to start the workflow on demand.

      After saving the workflow, you can run it from the Workflows page.

   2. Scheduled trigger

      Select Scheduled to run the workflow automatically.

      Depending on the selected schedule type, you can configure:

      • A one-time run
      • A recurring run
      • The start date and time
      • The recurrence pattern

Review the configured time and time zone before saving the workflow.

5. Add a Discovery - Use a Discovery step to identify the entry points in an application before scanning them.
   • Configure the Discovery settings, including the target and discovery method.
   • Select an Authentication Object if the target requires authentication.
   • Review the configuration and save the step.

When the workflow runs, Bright executes the Discovery using the configuration saved in the workflow.

5. Add a Scan - Use a Scan step to test the selected entry points for vulnerabilities.

   • Add a Scan step to the workflow.
   • Configure the desired statuses.
   • Select the security tests to run.
   • Configure authentication and optimization settings when required.

When a Scan follows a Discovery, Bright starts the Scan only after the Discovery step is completed successfully.

Important: If a step fails, dependent steps are not started.

5. Click on Run or Save

   For a workflow with a manual trigger:

   • You can run the workflow immediately

     OR save it for later

   • Once you save a workflow, its status will be "Ready"

   • Find the workflow you want to run in the workflows table.

   • Select Run.

   

   For a scheduled workflow

   Bright starts the workflow according to its configured schedule.

   • Each execution uses a snapshot of the workflow configuration at the time the run starts. Changes made later do not affect an active or completed run.

Monitor workflow execution

The Workflows page shows the configuration and execution state of each workflow.

The table includes:

Workflow status

The workflow status describes whether the workflow configuration is ready and eligible to run.

Possible statuses include:

Execution status

The execution status describes the state of a specific workflow run.

Possible statuses include:

View run details

To review a workflow execution, open its run history and select a run by simply clicking on the workflow entry.

The run details drawer displays:

• Status
• Start time
• End time
• Elapsed time
• Run ID

Click a run entry to open the workflow canvas for that specific execution.
The canvas displays the status of the workflow and each of its nodes.

From the run canvas, you can:

• Click Logs to review the workflow execution logs.

• Click a Discovery node to open its Discovery details page.
• Click a Scan node to open its Scan details page.

Stop a workflow run

To stop an active workflow:

• You can either do it from the menu by clicking on the 3 dots icon -> Stop
• Or do it from the workflow canvas by clicking the stop button

The execution status changes to Stopping while Bright processes the request, and then to Stopped.

Stopping a workflow prevents steps that have not started from running. Results produced before the workflow was stopped remain available in the relevant Discovery or Scan pages.

Edit a workflow

To update a workflow:

1. You can click on the 3 dots menu and click Edit
2. From a run history view, click on Edit within the canvas

The updated configuration applies to future runs only. It does not change the configuration snapshot stored for earlier or active runs.

Export a workflow configuration

You can export a workflow configuration for review or reuse.

1. Within the Canvas view -> Open the workflow actions menu.
2. Select Export.
3. Choose YAML or JSON.

Note: Workflow configuration can be exported as YAML or JSON. API-based workflow creation currently supports YAML.

Review results

Workflow steps use the existing Bright result pages:

• Discovery results are available on the relevant Discovery details page.
• Scan progress and results are available on the relevant Scan details page.
• Detected vulnerabilities are available on the Issues page.

The workflow run history keeps the relationship between the workflow execution and the Discovery or Scan entities created during that run.

Audit log

All workflow-related actions are recorded in the audit log, including:

• Creat

• Edit

• Run

  pause

• Resum

  Stop

• Delete

Troubleshooting

The workflow did not start

Check the following:

• The workflow is enabled.
• The workflow configuration is complete.
• The required Bright engines are available.
• The user who started the workflow has the required permissions.

A Scan step did not start

If the Scan depends on a Discovery, confirm that the Discovery completed successfully. A dependent Scan does not start when the preceding step fails.

The workflow failed

Open the run details and identify the failed step. Select the step to open its Discovery or Scan details page, where you can review the failure reason and available logs.

After correcting the configuration or target issue, start a new workflow run.

Changes are not reflected in an active run

This is expected. Each run stores a snapshot of the workflow configuration when it starts. Save your changes and start a new run to use the updated configuration.