Business Rules

SW360 Domain & Business Rules Specification Catalog based on OMG SBVR, RuleSpeak, and Specification by Example (SBE).

SW360 Business Rules & Domain Specifications

This section serves as the authoritative, machine- and human-readable catalog of functional domain constraints, business policies, and invariant behaviors implemented across SW360.

While Architecture Decision Records (ADRs) capture why specific architectural and technical stack decisions were chosen (based on Arc42 / DAR), Business Rules (BRs) document the exact domain requirements, behavioral policies, permission constraints, and side-effects that govern SW360 entities (Projects, Components, Releases, Licenses, Clearing, and Security).


1. Standards Foundation

Each SW360 Business Rule follows a formalized specification model combining:

  1. OMG SBVR & RuleSpeak® Notation: For formal, unambiguous rule definitions and operative policy statements.
  2. EARS (Easy Approach to Requirements Syntax): For clear state-, event-, and trigger-driven condition patterns.
  3. Specification by Example (SBE) & Gherkin (Given-When-Then): For clear developer understanding and automated test-case generation by developers and AI agents.
  4. Visual Diagrams (Optional / Mermaid): Diagrams should only be added when strictly necessary to clarify complex workflows or state machines. When included, they must be formatted as standard Mermaid diagrams (flowchart, stateDiagram-v2).

2. Rule Identification & Domains

Rules are uniquely identified using the scheme BR-<DOMAIN>-<NNN>:

Domain PrefixSubject AreaDescription
BR-PROJ-ProjectsProject lifecycle, clearing states, hierarchy, visibility, and access control
BR-COMP-ComponentsComponent cataloging, metadata consistency, merging, and ownership
BR-REL-ReleasesRelease lifecycle, source bundle handling, and license associations
BR-LIC-Licenses & ObligationsLicense compatibility, obligation fulfillment, and profile rules
BR-CLR-Clearing WorkflowsClearing states, requests, FOSSology integration, and report generation
BR-SEC-Security & VulnerabilitiesSVM synchronization, vulnerability assessment, and CVE relevance

3. Business Rule Catalog

Projects (BR-PROJ)

IDTitleGoverning ConfigurationStatus
BR-PROJ-001Closed Project Update Restrictionsprojects.closed.update.strictApproved
BR-PROJ-002License Clearing Tab Status BadgesLicenseClearing.tsxApproved

Clearing (BR-CLR)

IDTitleGoverning ConfigurationStatus
BR-CLR-001Release Clearing State Determination & Manual TransitionsReleaseServiceApproved

Security (BR-SEC)

IDTitleGoverning ConfigurationStatus
BR-SEC-001Security User Role & REST Filter RestrictionsEndpointsFilterApproved

4. Contributing New Rules

When documenting newly discovered invariants or creating functional specifications for new features:

  1. Copy the Business Rule Specification Template.
  2. Adhere to the Given-When-Then test scenario structure to allow direct verification by test automation and AI agents.
  3. Avoid unnecessary diagrams; include Mermaid diagrams only if they simplify complex decision branching or multi-state transitions.

Project Business Rules

Domain specifications and business constraints for SW360 Projects (Clearing states, visibility, hierarchies, and updates).

Clearing Workflows Business Rules

Domain specifications and business constraints for SW360 Clearing Workflows.

Security Domain Business Rules

Domain specifications and business constraints for SW360 Security, Vulnerabilities, and Security Roles.

Business Rule Specification Template