BR-CLR-001: Release Clearing State Determination & Manual Transitions

Mon, 01 Jan 0001 00:00:00 +0000

BR-CLR-001: Release Clearing State Determination & Manual Transitions

Standard Classification: State Machine / Behavioral Invariant & Lifecycle Constraint
Target Entity: Release, Attachment (CLEARING_REPORT, INTERNAL_USE_SCAN_REPORT, INITIAL_SCAN_REPORT), Integration Actions (Send to FOSSology)
Status: Approved
Enforcement Points: Backend Domain Services (ReleaseService.autosetReleaseClearingState, ComponentDatabaseHandler.evaluateClearingStateForScanAvailable)

1. Executive Summary & Formal Statements

1.1 Formal Statement (RuleSpeak® / EARS)

While updating a Release:
- If the user manually sets clearingState to UNDER_CLEARING and the prior clearingState is either NEW_CLEARING or REPORT_AVAILABLE, then the system shall preserve the manual state and skip automatic recalculation based on attachments.
- Otherwise, the system shall automatically determine and assign the clearingState according to the following evaluation precedence:
  1. If a Clearing Report (BestClearingReport) is attached:
  - If its checkStatus is ACCEPTED, then clearingState shall be APPROVED.
  - Otherwise (checkStatus is not ACCEPTED), then clearingState shall be REPORT_AVAILABLE.
  1. Else if an Internal Use Scan Report (BestInternalUseScanReport) is attached with checkStatus equal to ACCEPTED, then clearingState shall be INTERNAL_USE_SCAN_AVAILABLE.
  2. Else if an Initial Scan Report (INITIAL_SCAN_REPORT) is attached (evaluated via evaluateClearingStateForScanAvailable > 0), then clearingState shall be SCAN_AVAILABLE.
  3. Otherwise (no qualifying scan, internal use, or clearing reports exist), clearingState shall default to NEW_CLEARING.
When a user triggers the action “Send to FOSSology” on a Release:
- Then the system shall transition the release clearingState to SENT_TO_CLEARING_TOOL.

1.2 Purpose & Risk Mitigated

Automating the Release clearing lifecycle based on verified attachment artifacts eliminates human error and status drift, ensuring that releases are never marked APPROVED without an accepted clearing report. Allowing an explicit manual transition to UNDER_CLEARING from unverified or draft states (NEW_CLEARING, REPORT_AVAILABLE) enables clearing specialists to explicitly indicate active work on a release, preventing duplicate clearing efforts across distributed teams.

Clearing Workflows Business Rules on Eclipse SW360

BR-CLR-001: Release Clearing State Determination & Manual Transitions

BR-CLR-001: Release Clearing State Determination & Manual Transitions

1. Executive Summary & Formal Statements

1.1 Formal Statement (RuleSpeak® / EARS)

1.2 Purpose & Risk Mitigated