adm_job_automations_api
This document contains the API documentation for the adm_job_automations_api package.
Functions and Procedures
Section titled “Functions and Procedures”delete_user_trash
Section titled “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
Section titled “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
Section titled “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
Section titled “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
Section titled “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 |
daily_job
Section titled “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;