Skip to main content

Alternate Match Codes (To be removed)

Description​

The Alternate Match Codes screen appears when the system finds multiple valid matches for a scanned item in the match database. Instead of automatically selecting one match, the user must choose which specific item they intend to scan. This screen is triggered in two contexts: during normal scanning in Add Scans mode, and during Zone Linking when matching zone identifiers. The system displays a list of all possible matches with their identifying information, allowing the user to select the correct one by scanning its alternate match code or choosing from the list.

When This Screen Appears​

Scan Mode Context​

When scanning an item in the Add Scans screen:

  1. User scans or enters a value for a scan flow step that has matching enabled.
  2. SubmitOpenScanProperty queries the match database for that value.
  3. The match database returns multiple possible matches (stored in alternateMatchCodes).
  4. If showDialog is true in the alternate match codes result, the system navigates to this screen.
  5. The open scan is saved with the alternate match codes attached, waiting for user selection.
  6. User must select one of the alternate matches to continue scanning.

Zone Linking Context​

When linking zones:

  1. User scans a zone linking step value (like a location code or zone identifier).
  2. SubmitOpenZoneLinkingProperty queries the match database.
  3. Multiple zones match the scanned value.
  4. System navigates to this screen to let user choose the correct zone.
  5. User selects the intended zone to complete the linking process.

Functionality​

Selection Options​

  • Scan to Select: User can scan the alternate match code shown in the list to automatically select that match.
  • Tap to Select: User can tap a match from the displayed list.
  • Search: User can type to filter the list of alternate matches.

After Selection​

Once the user selects a match:

  1. The system submits the selected match code back through SubmitOpenScanProperty (Scan mode) or SubmitOpenZoneLinkingProperty (Zone Linking mode).
  2. The discardMatchCodes parameter is set to true to clear the alternate matches.
  3. The clearProperties parameter is set to true (Scan mode only) to restart the scan with the selected match.
  4. The screen exits and returns to the previous flow.
  5. The selected match data populates the relevant fields automatically.

Validation After Selection​

Even after the user selects an alternate match, that selection goes through validation:

  • If the selected match code fails validation (e.g., doesn't actually exist), a MatchFailedException is shown.
  • If allowNotMatched is true, user can proceed anyway with a warning.
  • If validation succeeds, the match data is applied and the user returns to the scan flow.

Fields​

  • Search Text: Filter the list of alternate matches by typing.

Error Messages​

  • Match code not found: The scanned or entered value doesn't match any of the alternate match codes in the list.
  • MatchFailedException: The selected alternate match code failed validation when resubmitted.
  • NonExistingStep: The scan flow step or zone linking step associated with the alternate matches no longer exists (cleans up invalid state).