Subworkflow – Waive Linked Account Fines for CLS Long Lost Items

Waives a CLS Long Lost replacement fine in a patron's linked account within the lending Institution Zone. Returns the waiver status so the parent workflow can verify whether the fine was successfully removed before adding the replacement fine to the patron's home account.

At a glance

• Status: Active
• Environment / Tags: Network Zone, Live, CLS Long Lost Items
• Applies consortium-wide?: Yes
• Runs on: WRLC Network Zone, against the Alma Institution Zone specified by the incoming Institution Code
• Trigger: Called by another Library Open Workflow (subworkflow); it does not run on its own.
• Primary outcome: Waives a CLS Long Lost replacement fine in a patron's linked account and returns the status of the waiver along with the original input data.
• Who receives results: No direct recipients. The output is returned to the parent workflow for additional processing.

Why this exists

As part of the WRLC CLS Long Lost Items process, replacement fines must be waived from the patron's linked account while an equivalent replacement fine is added to the patron's home institution. This subworkflow standardizes the waiver process so that parent workflows can waive fines in any participating Institution Zone using the same logic.

What it does

• Accepts the following input fields from a parent workflow:
  • Institution Code
  • User Primary Identifier
  • Fine Fee Id
  • Remaining Amount
• Uses the Institution Code to connect to the appropriate Alma Institution Zone.
• Calls the Alma Fines and Fees API to waive the specified fine for the patron.
• Waives the remaining balance of the fine.
• Records a standard waiver comment indicating that the linked-account fine has been waived and re-added to the patron's home account.
• Continues processing even if the Alma API returns an error.
• Captures either:
  • the successful waiver status returned by Alma, or
  • the error message returned by Alma if the waiver fails.
• Adds a new output field named Linked Account Fine Status while preserving all original input fields.
• Returns the updated record to the calling workflow.

Where it runs

• Alma IZ(s): Any participating WRLC Institution Zone specified by the incoming Institution Code
• Systems touched:
  • Alma APIs (Fines and Fees API)
  • Alma Network routing node
• Reports / queries used: None

How it works

Logic overview

• The parent workflow passes the required patron and fine information into this subworkflow.
• The workflow routes the API call to the Institution Zone identified by the incoming Institution Code.
• The Alma API attempts to waive the specified fine using the remaining balance as the waiver amount.
• The workflow is configured to continue even if the API returns an error.
• An Edit Fields node creates a Linked Account Fine Status field by:
  • using the returned status when the waiver succeeds, or
  • using the Alma error message when the waiver fails.
• The workflow returns all original fields plus Linked Account Fine Status to the parent workflow.

If results exist

The fine is successfully waived and Linked Account Fine Status contains the status returned by Alma (for example, indicating that the waiver completed successfully).

If no results

If the waiver cannot be completed, the workflow still returns the original data. Linked Account Fine Status contains the Alma error message so the parent workflow can determine how to handle the failure.

Artifacts produced: None. This subworkflow returns data only; it does not create files, reports, or send emails.