Skip to main content

Listing and Managing Processes

The processes page at /repositories/:repositoryId/processes shows the executions related to a repository. Use it to create processes, track current work, retry interrupted runs, download completed results, or remove process records.

When to use​

  • Use the page to review all processes for a repository.
  • Use it to track statuses and open execution details.
  • Use it to download results from completed processes.
  • Use it to stop, restart, or delete a process when the action is available.

Before you start​

  • Confirm the active organization.
  • Open a repository that has completed pre-analysis.
  • Check that no conflicting process is already pending or running.

Accessing processes​

You can open the process list from:

  • The Processes tab in the repository workspace.
  • The recommended action on the repositories page.
  • The command palette when a repository is active.

If you enter from a global route, select a repository first. The repository must be ready for execution. If no repository is available, the page guides you back to the repository list.

Understand the list​

The list shows the executions for the selected repository. You can:

  • Search by name, description, type, language, or status.
  • Filter by status.
  • Create a new process.
  • Open process details.
  • Download the result of a completed process.
  • Restart a failed, cancelled, or revoked process.
  • Stop a running or pending process.
  • Delete a process.

Process statuses​

Processes can have the following statuses:

  • PENDING: created and waiting to run.
  • RUNNING, STARTED, RECEIVED, RETRY: in progress.
  • SUCCESS: completed and results are available.
  • FAILURE: failed.
  • REVOKED: revoked.
  • CANCELLED: cancelled.
  • STOPPING: the app is stopping a running process.

When pending or in-progress processes exist, the list refreshes automatically at intervals. Success messages appear temporarily and can be dismissed. Error messages remain visible until you close them, so the reason can be read before retrying.

Process actions​

Available actions depend on the status:

  • View: opens the process detail and progress screen.
  • Download: downloads the result package for a successful process.
  • Stop: asks for confirmation before stopping a running or pending process.
  • Restart: starts a new attempt for a failed, cancelled, or revoked process.
  • Delete: removes the process after confirmation.

If the API blocks a new process because another is pending or running, wait for the active one to finish or stop it before creating another.

Process status sequence​

Processes usually move from PENDING to worker states such as RECEIVED, STARTED, and RUNNING. They can then finish with SUCCESS, fail with FAILURE, retry with RETRY, or move to STOPPING and CANCELLED when a stop is requested.

Revoked, failed, or cancelled processes can be restarted when the action is available. Before restarting, review the visible error message and logs in the process detail screen.

Knowledge base behavior​

Process execution contributes to the repository knowledge base. Later documentation can benefit from information collected by earlier runs, and downloaded results can include cumulative content depending on the selected options.

Expected result​

The list should show the current state of executions and offer only actions compatible with each status.

See also​