adm_job_automations_api

This document contains the API documentation for the adm_job_automations_api package.

Functions and Procedures

delete_user_trash

Permanently deletes documents from user trash folders that are eligible for deletion

Signature:

procedure delete_user_trash (
  po_error_occurred out nocopy boolean
);

Parameters:

Name	Direction	Type	Description
po_error_occurred	out	nocopy boolean	Output parameter indicating if an error occurred during deletion

---

delete_retention_files

Deletes documents that have reached their retention policy expiration date

Signature:

procedure delete_retention_files (
  po_error_occurred out nocopy boolean
);

Parameters:

Name	Direction	Type	Description
po_error_occurred	out	nocopy boolean	Output parameter indicating if an error occurred during deletion

---

delete_expired_embed_tokens

Removes expired embed tokens that are no longer valid for document access

Signature:

procedure delete_expired_embed_tokens (
  po_error_occurred out nocopy boolean
);

Parameters:

Name	Direction	Type	Description
po_error_occurred	out	nocopy boolean	Output parameter indicating if an error occurred during deletion

---

process_storage_migrations

Processes pending storage migrations between blob and object storage

Signature:

procedure process_storage_migrations (
  po_error_occurred out nocopy boolean
);

Parameters:

Name	Direction	Type	Description
po_error_occurred	out	nocopy boolean	Output parameter indicating if an error occurred during migration processing

---

process_pending_object_storage_deletions

Processes and executes pending object storage deletion operations

Signature:

procedure process_pending_object_storage_deletions (
  po_error_occurred out nocopy boolean
);

Parameters:

Name	Direction	Type	Description
po_error_occurred	out	nocopy boolean	Output parameter indicating if an error occurred during deletion processing

---

process_indexing_queue

Processes the indexing queue by extracting text content from blobs and updating the index_content column

Signature:

procedure process_indexing_queue (
  po_error_occurred out nocopy boolean
);

Parameters:

Name	Direction	Type	Description
po_error_occurred	out	nocopy boolean	Output parameter indicating if an error occurred during indexing processing

---

process_object_storage_checksum_verification

Verifies object storage file checksums against local database values Logs any mismatches found for investigation

Signature:

procedure process_object_storage_checksum_verification (
  po_error_occurred out nocopy boolean
);

Parameters:

Name	Direction	Type	Description
po_error_occurred	out	nocopy boolean	Output parameter indicating if an error occurred during checksum verification

---

process_metadata_backfill

Backfills file metadata annotations for documents that have never been processed (no file.extracted_at annotation), e.g. documents uploaded before the feature existed or while it was disabled. Skips when the FILE_METADATA_EXTRACTION setting is disabled; processes at most adm_settings_api.get_metadata_backfill_batch_size documents per run to bound object storage downloads.

Signature:

procedure process_metadata_backfill (
  po_error_occurred out nocopy boolean
);

Parameters:

Name	Direction	Type	Description
po_error_occurred	out	nocopy boolean	Output parameter indicating if an error occurred during backfill

---

daily_job

Main daily job procedure that orchestrates all automated maintenance tasks This procedure is typically scheduled to run once per day

Signature:

procedure daily_job;

---