Skip to main content

Delete NZ Bib Set

Form accepts an NZ Set ID, displays a deletion review screen with record count, and submits Alma’s Delete Bibliographic Records job (M28) to permanently remove all records in that set.

At a glance

  • Status: Active

  • Environment / Tags: Network Zone; Live

  • Applies consortium-wide?: Yes — operates on Alma Network Zone bibliographic sets

  • Runs on: Alma Network Zone (NZ)

  • Trigger: Manual form submission (Set ID entry)

  • Primary outcome: Submits an Alma job to permanently delete all bibliographic records in a specified NZ set.

  • Who receives results: The submitting user sees an on-screen confirmation or error message (no email is sent).


Why this exists

Network Zone cleanup workflows often produce itemized bibliographic sets that are ready for deletion after review. Rather than requiring staff to manually navigate Alma job screens, this workflow provides a controlled, review-based interface to:

  • Confirm the correct set

  • Display record count

  • Submit the deletion job

  • Provide immediate feedback

It centralizes destructive actions behind a visible approval step.


What it does

  • Presents a form requesting an NZ Set ID.

  • Retrieves the set from Alma.

  • Displays:

    • Set ID

    • Set name

    • Number of records in the set

  • Warns that deletion is permanent.

  • Upon confirmation, submits Alma Job M28 (Delete Bibliographic Records).

  • Displays a completion message.

  • If retrieval fails, displays the Alma error message.


Where it runs

  • Alma IZ(s):

    • Alma Network Zone

  • Systems touched:

    • Alma APIs (Set retrieval and job submission)

  • Reports / queries used: None

Credential referenced:

  • NZ Production – Alma APIs – Read & Write


How it works

Logic overview

1. Form Submission

The workflow begins with the form:

Delete NZ Bibliographic Set

Required field:

    • Set ID

The description indicates this Set ID may come from a LibOW email notifying staff that a set is ready for deletion.

2. Retrieve Set

The workflow calls:

GET /almaws/v1/conf/sets/{set_id}

If retrieval fails:

    • The workflow branches to an error form.

    • The Alma error message is displayed.

If retrieval succeeds:

    • The workflow proceeds to a review screen.

3. Review Screen (Manual Approval Step)

The review form displays:

    • Set ID

    • Set Name

    • Record Count (number_of_members)

    • A prominent warning that deletion is permanent

⚠️ Current safeguards:

    • No typed confirmation required

    • No checkbox approval

    • No automatic size threshold

    • No content validation

Approval is implicit by proceeding.

4. Submit Deletion Job

The workflow submits Alma Job M28 (Delete Bibliographic Records) with:

    • HANDLE_INVENTORY_BIBS = false

    • HANDLE_RELATED_BIBS = false

    • set_id = retrieved set

    • Job name:

      • "Delete Bibliographic records - via API - {set name}"

This deletes all bibliographic records in the set without handling inventory or related bibs.

5. Completion Message

The final screen displays:

“The set is currently being deleted in the NZ.”

No email confirmation is sent.


If results exist
  • The deletion job is successfully submitted.

  • Alma processes deletion asynchronously.

  • User sees confirmation message.

  • All bibliographic records in the specified NZ set are permanently deleted.

If no results
  • If the Set ID is invalid or retrieval fails:

    • An error message is displayed.

    • No deletion job is submitted.

  • If the set contains zero records:

    • The job is still submitted.

    • Alma processes with zero deletions.


Artifacts produced

  • Alma Job submission:

    • Job ID: M28 (Delete Bibliographic Records)

  • No files, reports, or emails.

  • No audit export generated by the workflow itself.