Activity History

Canopy maintains project activities within the project space. Project activity history is archived when the admin archives the project and disposed of when the admin deletes the project.

Project Administrators can view the Activity History page by clicking on the Activity tab under Project Settings.

Legacy Activity History

How to search on activities from the older interface format (legacy activities) Legacy activities do not follow the same format and will be converted over time. Canopy supports legacy formatted activities by mapping the fields as follows:

New UI Field	Legacy UI Field
Begin Date/Time	Date and Time
End Date/Time	Date and Time or leave blank if it does not exist.
Activity Class	Leave Blank
Type	Activity Type
Job ID	Leave Blank
User	User Name (Email Address)
Description	Current description excluding the user name.
Details	Details

Activity History

Some activities are associated with a job. Job ID allows users to group events related by activity. Job activity can be used to understand who, what, how, and when related work to a single action was applied.

How to Filter On All the Activities of a Run Consolidation Job

Sign in as a Project Administrator.
Select the project you are working on.
In the upper-right corner of any page on Canopy, click Settings, click Project, and then click on Activities.
Select the Class filter from the header of the data grid.
Add Consolidation to is any of selected filter.
Once filtered, scroll to your right and copy the job ID of the run consolidation job you would like to filter.
Select the Job ID filter and paste the job ID you just copied into the filter.
Paste the job ID you just copied into the is any of these filter.
Done

Generic Job States

Background jobs or services typically have states to reflect their lifecycle or current status. Here’s a list of job states:

Initial/Pre-Execution States (Appears in the Job Manager’s Working Tab)

Created: Job has been initialized but not yet scheduled or processed.
Queued: Waiting in line to be executed.
Dequed: Job has been dequeued as part of a cancellation request.

Active States (Appears in the Job Manager’s Working Tab)

Working: Actively being processed or executed.
Waiting: Temporarily on hold, waiting for external resources or conditions to proceed.
Canceling: The user pressed cancel, and the job is in the process of canceling.

Completion States (Appears in the Job Manager’s Completed Tab)

Completed: Successfully finished processing without errors.
Canceled: Terminated by external intervention before completion.
Partially Completed: Completed some work completed successfully but encountered issues with others.

Completed with Error (Appears in the Job Manager’s Failed Tab)

Failed: Execution terminated due to errors.
Timed Out: Failed to complete within an allotted time frame.

---
title: Job Template
---
stateDiagram-v2
%% UX Text

    decision_process : Background task?
    cancel_process : User pressed cancel?
    error_process: Error encountered?
    queued_process: Job queued?
    backup_process : Backup supported?
    restore_process : Backup exists?
    retry_process : User selects retry job?

%% composites
    state work {
        working --> waiting : Resource constraint
        waiting --> working : Retry job
    }
    state working {
       [*]
    }
    state create {
        [*]
    }
    state fail {
        [*]
        timeout
    }
    state cancel {
        
        queued_process
        queued_choice
        canceling
        canceled
        restore_choice
        restore_process
    }

    state partial {
        [*]
    }
    state success {
        [*]
    }
    state complete {
        success
        partial
    }
    state backup {
        [*]
    }
    state restore {
        [*]
    }
    state queue {
        requeue
        enqueue
        dequed
    }

%% choices
	state background_choice <<choice>>
    state cancel_choice <<choice>>
    state error_choice <<choice>>
    state queued_choice <<choice>>
    state backup_choice <<choice>>
    state restore_choice <<choice>>
    state retry_choice <<choice>>
%% forks
state fork_state <<fork>>
      create --> fork_state
      fork_state --> cancel_process
      fork_state --> decision_process
      fork_state --> error_process

%% state diagram
    %% Request job
    [*] --> create

    %% Run task
    decision_process --> background_choice
	background_choice --> working : No, start process in foreground
	background_choice --> enqueue : Yes, enqueue in background
    enqueue --> backup_process
    backup_process --> backup_choice
    backup_choice --> backup : Yes, backup
    backup_choice --> working : No, start work
    backup --> working : Start work


    

    working --> success : Completed - Success
    working --> partial : Completed - Partial Success
    success --> [*]
    partial --> [*]

    cancel_process --> cancel_choice : Yes
    cancel_choice --> queued_process
    cancel_choice --> cancel_process : No, listen for cancel

    queued_process --> queued_choice
    queued_choice --> dequed : Yes, dequeue job
    queued_choice --> canceling : No, cancel work

    canceling --> restore_process
    restore_process --> restore_choice
    restore_choice --> restore : Backup exists, restore
    restore_choice --> canceled :  Completed - Canceled Work
    restore --> canceled  : Completed - Canceled Work and Restored Previous State

    dequed --> canceled : Completed - Dequeued Job
    canceled --> [*]

    error_process --> error_choice : Yes
    error_choice --> fail : Completed - Failure Error
    error_choice --> timeout : Incomplete - Failure Time Out
    error_choice --> error_process : No, listen for error

    fail --> [*]
    timeout --> retry_process
    retry_process --> retry_choice
    retry_choice --> requeue : Yes, queue to try again
    retry_choice --> retry_process : No, listen for retry
    requeue --> enqueue

List of New/Updated Activities by Class

Classes are created to logically group activity types that belong to the same module or workflow in the application.

The following is a list of activities captured by class:

Activity History

Tracks exports created from the activity history, including the export name and ID.

Type	Description
Export	Created the export named {{export_name}} for download with export ID: {{export_id}}.

Bulk Map

Captures bulk mapping operations on documents, including successful uploads, completions, and failures.

Type	Description
Complete	Successfully bulk mapped documents. Document IDs: {{val, list}}
Upload	Successfully uploaded document for bulk mapping. Document IDs: {{val, list}}
Fail	Failed to upload document for bulk mapping. Document IDs: {{val, list}}

Bulk Search Report

Records the full lifecycle of bulk search reports — creation, editing, running, downloading, tagging, renaming, copying, saving, stopping, and errors.

Type	Description
Completed	Completed report {{report_name}} {{report_id}} job {{job_id}}.
Copy	Copied {{report_name}} {{report_id}} to {{copied_report_name}} {{copied_report_id}}.
Create	Created report {{report_name}} {{report_id}}.
Download	Downloaded report {{report_name}} {{report_id}} job {{job_id}} as a {{CSV
Edit	Edited report {{report_name}} {{report_id}}. See details for config only.
Error	{‘scope’: ‘Running report {{report_name}} {{report_id}} resulted in a(n) {{scope
Rename	Renamed report from {{report_name}} to {{report_name}} {{report_id}}.
Save As	Saved {{report_name}} {{report_id}} job {{job_id}} to {{save_as_report_name}} {{save_as_report_id}}.
Save	Saved report {{report_name}} {{report_id}}. See details for config only.
Search	Started run search report {{report_name}} {{report_id}} job {{job_id}}.
Stop	Stopped report {{report_name}} {{report_id}} job {{job_id}}.
Tag	Started run search and tagging report {{report_name}} {{report_id}} job {{job_id}}.

Consolidation / Delete Consolidated List

Tracks the full consolidation workflow including queuing, backup, clustering, conflict checking, synchronization, deletion, restoration, stopping, and completion states.

Type	Description
Backed Up	Backed up {{master, number}} master and {{raw, number}} raw entities.
Paused	“Back up paused.”, “Clustering paused.”, “Conflict checking paused.”, “Deletion paused.”, “Restoration of consolidated entities paused.”, “Restoration of raw entities paused.”, “Stopping background process paused.”, or “Synchronization paused.”
Backing Up	Backing up master and raw entities.
Clustered	Deduplicated {{deduped, number}} and clustered {{completed, number}} entities by rules.
Clustering	Clustering sets by duplicates and rules.
Checked	Check completed with {{conflicts, number}} conflicts and {{consolidated, number}} consolidated entities.
Checking	“Checking conflicts per settings.”
Deleted	“Manual decisions deleted.”, “Consolidated list deleted.”, or “Consolidated list and decisions deleted.”
Deleting	“Deleting manual decisions only.”, “Deleting consolidated list only.”, or “Deleting consolidated list and manual decisions.”
Completed	“Process completed.”
Queued	Process queued using ruleset: {{ruleset}}."
Started	Process started.
Restored	“Restored consolidated entities.” or “Restored raw entities.”
Restoring	“Restoring consolidated entities.” or ““Restoring raw entities.”
Stopped	Stopped background process.
Stopping	Stopping background process.
Synchronized	Synchronized {{new, number}} new, {{update, number}} changed, and {{deleted, number}} deleted entities.
Synchronizing	Synchronizing new, changed, and deleted entities.

Exports

Records export downloads, completion notification emails, and temporary download link creation.

Type	Description
Download	Downloaded an export.
Complete Email	Subject: Canopy Export Completed! – when document related exports completed From: {{from_email}} To: {{to_email}} Message ID: {{MessageId}}
Link	Created a temporary download link for an export.

Document List View

Tracks view management operations including creating, copying, deleting, moving, renaming, sharing, and unsharing document list views and folders.

Type	Description
Copy	Copied view {{view_name}} {{view_id}}.
Create	Created view {{view_name}} {{view_id}}.
Delete	Deleted view {{view_name}} {{view_id}}.
Move	Moved view {{view_name}} {{view_id}} from folder {{folder_name}} to folder {{folder_name}}.
Rename	{‘rename_folder’: ‘Renamed folder from {{from_folder_name}} to {{to_folder_name}}.’, ‘rename_view’: ‘Renamed view from {{view_name}} to {{view_name}} {{view_id}}.’}
Share	{‘with_role’: ‘Shared view {{view_name}} {{view_id}} with {{user_role}.’, ‘with_user’: ‘Shared view {{view_name}} {{view_id}} with {{user_name}.’}
Stop Share	{‘stop_share_with_role’: ‘Stopped sharing view {{view_name}} {{view_id}} with {{user_role}}.’, ‘stop_share_with_user’: ‘Stopped sharing view {{view_name}} {{view_id}} with {{user_name}}.’}

Microsoft 365

Captures Microsoft 365 plugin admin consent email notifications.

Type	Description
Consent Email	Subject: Canopy M365 Plugin - Admin Consent From: {{from_email}} To: {{to_email}} Message ID: {{MessageId}}

Session

Tracks user session lifecycle within a project, including entering, becoming active, exiting, and timing out.

Type	Description
Active	Active in project. Session {{session_id}}.
Entered	Entered the project. Session {{session_id}}.
Exited	Exited the project. Session {{session_id}}.
Timed Out	Logged out after {{val}} minutes of inactivity {{session_id}}. Session {{session_id}}.

Views

Tracks view management including creating, copying, deleting, moving between folders, renaming, sharing, unsharing, and updating views.

Type	Description
Copy	Copied view {{view_name}} {{view_id}}.
Create	Created view {{view_name}} {{view_id}}.
Delete	Deleted view {{view_name}} {{view_id}}.
Move	{‘folder_to_folder’: ‘Moved view {{view_name}} {{view_id}} from folder {{from_folder_name}} to folder {{to_folder_name}}.’, ‘folder_to_root’: ‘Moved view {{view_name}} {{view_id}} from folder {{from_folder_name}} to the root folder.’, ‘root_to_folder’: ‘Moved view {{view_name}} {{view_id}} from the root folder to folder {{to_folder_name}}.’}
Rename	{‘folder’: ‘Renamed folder from {{from_folder_name}} to {{to_folder_name}}.’, ‘view’: ‘Renamed view from {{from_view_name}} to {{to_view_name}} {{view_id}}.’}
Share	{‘user_name’: ‘Shared view {{view_name}} {{view_id}} with {{user_name}}.’, ‘user_role’: ‘Shared view {{view_name}} {{view_id}} with {{user_role}}.’}
Stop Share	{‘user_name’: ‘Stopped sharing view {{view_name}} {{view_id}} with {{user_name}}.’, ‘user_role’: ‘Stopped sharing view {{view_name}} {{view_id}} with {{user_role}}.’}
Update	Updated view {{view_name}} {{view_id}}.

Entity Deletion

Tracks the complete entity deletion job lifecycle — from selection (by checkbox, filter, or document view) through queuing, backup, working, completion, partial completion, failure, timeout, cancellation, and restoration.

Type	Description
Back Up	Backup completed
Back Up	Backup started
Canceled	Process terminated by user successfully.
Canceling	The user pressed cancel, and the job is in the process of canceling.
Completed	Deleted $t(raw_entities, {“count”: {{raw_entities}} }) from document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN> and updated $t(master_entities, {“count”: {{master_entities}} }).
Completed	Deleted $t(raw_entities, {“count”: {{raw_entities}} }), deleted $t(master_entities, {“count”: {{master_entities}} }), and updated $t(master_entities, {“count”: {{master_entities}} }) impacting $t(documents, {“count”:{{documents}} }).
Completed	Deleted $t(raw_entities, {“count”: {{raw_entities}} }) from entity detail view document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN> and updated $t(master_entities, {“count”: {{master_entities}} }).
Create	Selected all resulting in $t(raw_entities, {“count”: {{raw_entities}} }) from a document in Document View in document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN>.
Create	Selected all resulting in $t(raw_entities, {“count”: {{raw_entities}} }) from a sheet in Document View in document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN>.
Create	Selected $t(master_entities, {“count”: {{master_entities}} }) by checking boxes on the Consolidated Entity List.
Create	Selected $t(raw_entities, {“count”: {{raw_entities}} }) by checking boxes on the Raw Entity List.
Create	Selected $t(master_entities, {“count”: {{master_entities}} }) by applying filters to the Consolidated Entity List.
Create	Selected $t(raw_entities, {“count”: {{raw_entities}} }) by applying filters to the Raw Entity List.
Create	Selected a single raw entity from the Document View in document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN>.
Create	Selected a single related raw entity from a consolidated entity’s Master Entity Detail screen. The raw entity was from document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN>.
Dequeued	The user pressed cancel and system dequeued the Job.
Enqueue	Waiting to be executed.
Fail	Job terminated unexpectedly. Open a customer support ticket and request assistance.
Fail	Job failed because service was not available. Open a customer support ticket and request assistance.
Partially Completed	Deleted $t(raw_entities, {“count”: {{raw_entities}} }) from document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN>, updated {{master_entities}}, and skipped {{entities}}.
Partially Completed	Deleted $t(raw_entities, {“count” {{raw_entities}} }), deleted $t(master_entities, {“count” {{master_entities}} }), and updated $t(master_entities, {“count” {{master_entities}} }) impacting $t(documents, {“count” {{documents}} }). Skipped $t(raw_entities, {“count” {{raw_entities}} }).
Restore	Restore completed
Restore	Restore started
Timed Out	Failed to complete within the allotted time frame. Open a customer support ticket and request for Canopy to retry the job.
Waiting	Process temporarily on hold, waiting for external resources or conditions to proceed.
Working	Deleting $t(clustered_entities, {“count”: {{clustered_entities}} })
Working	Deleting $t(master_entities, {“count”: {{master_entities}} }) containing no merged or clustered entities
Working	Deleting $t(merged_entities, {“count”: {{merged_entities}} })
Working	Deleting $t(raw_entities, {“count”: {{raw_entities}} })
Working	Deleting Raw Entities From Masters
Working	Deleting Raw Entities From Documents or Raw List
Working	Updating $t(master_entities, {“count”: {{master_entities}} })

Click here to see the Entity Deletion activity flow. ↕

---
title: Entity Deletion
---
stateDiagram-v2
%% UX Text
backup : Back Up
backup : Back Up
backup.backup_completed : Backup completed
backup : Back Up
backup.backup_started : Backup started
canceled : Canceled
canceled : Canceled
canceled.canceled : Process terminated by user successfully.
canceling : Canceling
canceling : Canceling
canceling.canceling : The user pressed cancel, and the job is in the process of canceling.
completed : Completed
completed : Completed
completed.document_entity_delete : Deleted $t(raw_entities, {"count" {{raw_entities}} }) from document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN> and updated $t(master_entities, {"count" {{master_entities}} }).
completed : Completed
completed.entity_list_delete : Deleted $t(raw_entities, {"count" {{raw_entities}} }), deleted $t(master_entities, {"count" {{master_entities}} }), and updated $t(master_entities, {"count" {{master_entities}} }) impacting $t(documents, {"count"{{documents}} }).
completed : Completed
completed.master_entity_detail_entity_delete : Deleted $t(raw_entities, {"count" {{raw_entities}} }) from entity detail view document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN> and updated $t(master_entities, {"count" {{master_entities}} }).
create : Create
create : Create
create.select_all_entities_from_document : Selected <strong>all</strong> resulting in $t(raw_entities, {"count" {{raw_entities}} }) from a document in Document View in document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN>.
create : Create
create.select_all_entities_from_sheet : Selected <strong>all</strong> resulting in $t(raw_entities, {"count" {{raw_entities}} }) from a sheet in Document View in document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN>.
create : Create
create.select_checkboxes_from_master_list : Selected $t(master_entities, {"count" {{master_entities}} }) by checking boxes on the Consolidated Entity List.
create : Create
create.select_checkboxes_from_raw_list : Selected $t(raw_entities, {"count" {{raw_entities}} }) by checking boxes on the Raw Entity List.
create : Create
create.select_filters_from_master_list : Selected $t(master_entities, {"count" {{master_entities}} }) by applying filters to the Consolidated Entity List.
create : Create
create.select_filters_from_raw_list : Selected $t(raw_entities, {"count" {{raw_entities}} }) by applying filters to the Raw Entity List.
create : Create
create.select_single_entity_from_document : Selected a single raw entity from the Document View in document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN>.
create : Create
create.select_single_entity_from_master_entity_detail : Selected a single related raw entity from a consolidated entity's Master Entity Detail screen. The raw entity was from document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN>.
dequeued : Dequeued
dequeued : Dequeued
dequeued.dequeued : The user pressed cancel and system dequeued the Job.
enqueue : Enqueue
enqueue : Enqueue
enqueue.enqueue : Waiting to be executed.
fail : Fail
fail : Fail
fail.failed : Job terminated unexpectedly. Open a customer support ticket and request assistance.
fail : Fail
fail.failed_service_not_available : Job failed because service was not available. Open a customer support ticket and request assistance.
partial : Partially Completed
partial : Partially Completed
partial.partial_document_entity_delete : Deleted $t(raw_entities, {"count" {{raw_entities}} }) from document <CPY_SEARCH_ID_LINK_BTN>{{search_id}}</CPY_SEARCH_ID_LINK_BTN>, updated {{master_entities}}, and skipped {{entities}}.
partial : Partially Completed
partial.partial_entity_list_delete : Deleted $t(raw_entities, {"count" {{raw_entities}} }), deleted $t(master_entities, {"count" {{master_entities}} }), and updated $t(master_entities, {"count" {{master_entities}} }) impacting $t(documents, {"count" {{documents}} }).  Skipped $t(raw_entities, {"count" {{raw_entities}} }).
restore : Restore
restore : Restore
restore.restore_completed : Restore completed
restore : Restore
restore.restore_started : Restore started
retry : Retry
timeout : Timed Out
timeout : Timed Out
timeout.timeout : Failed to complete within the allotted time frame. Open a customer support ticket and request for Canopy to retry the job.
waiting : Waiting
waiting : Waiting
waiting.waiting : Process temporarily on hold, waiting for external resources or conditions to proceed.
working : Working
working : Working
working.deleting_clustered : Deleting $t(clustered_entities, {"count" {{clustered_entities}} })
working : Working
working.deleting_master : Deleting $t(master_entities, {"count" {{master_entities}} }) containing no merged or clustered entities
working : Working
working.deleting_merged : Deleting $t(merged_entities, {"count" {{merged_entities}} })
working : Working
working.deleting_raw : Deleting $t(raw_entities, {"count" {{raw_entities}} })
working : Working
working.deleting_raw_from_master : Deleting Raw Entities From Masters
working : Working
working.deleting_raw_from_raw : Deleting Raw Entities From Documents or Raw List
working : Working
working.updating_masters : Updating $t(master_entities, {"count" {{master_entities}} })
    decision_process : Background task?
    cancel_process : User pressed cancel?
    error_process : Error encountered?
    queued_process : Job queued?
    backup_process : Backup supported?
    restore_process : Backup exists?
    retry_process : User selects retry job?


%% composites
    state create {
        direction LR
        create.select_all_entities_from_document
        create.select_all_entities_from_sheet
        create.select_checkboxes_from_raw_list
        create.select_filters_from_raw_list
        create.select_checkboxes_from_master_list
        create.select_filters_from_master_list
        create.select_single_entity_from_document
        create.select_single_entity_from_master_entity_detail
    }

    state working {
       [*] --> working.deleting_raw_from_master
       working.deleting_raw_from_master --> [*]
       [*] --> working.deleting_raw_from_raw
       working.deleting_raw_from_raw --> [*]
       %%working_deleting_raw_from_master --> working_delete_entity
       %%working_delete_entity --> working_deleting_raw_from_master
       %%working_deleting_raw_from_raw --> working_delete_entity
       %%working_delete_entity --> working_deleting_raw_from_raw

    }
    state working.deleting_raw_from_raw {
        working.deleting_raw --> working.updating_masters
    }

    state backup {
        backup.backup_started --> backup.backup_completed
    }

    state restore {
        restore.restore_started --> restore.restore_completed
    }

    state working.deleting_raw_from_master {
        working.deleting_master --> working.deleting_clustered
        working.deleting_clustered --> working.deleting_merged
    }
    state timeout {
        timeout.timeout
    }
    state fail {
        direction LR
        fail.failed
        fail.failed_service_not_available
    }

    state dequeued {
        dequeued.dequeued
    }
    state canceling {
        canceling.canceling
    }
    state canceled {
        canceled.canceled
    }
    state enqueue {
        enqueue.enqueue
    }
    state partial {
        direction LR
        partial.partial_document_entity_delete
        partial.partial_entity_list_delete
    }
    state completed {
        direction LR
        completed.document_entity_delete
        completed.entity_list_delete
        completed.master_entity_detail_entity_delete
    }
    state waiting {
        waiting.waiting
    }
    state retry {
        [*]
    }



%% choices
	state background_choice <<choice>>
    state cancel_choice <<choice>>
    state error_choice <<choice>>
    state queued_choice <<choice>>
    state backup_choice <<choice>>
    state restore_choice <<choice>>
    state retry_choice <<choice>>

%% forks
state fork_state <<fork>>
      create --> fork_state
      fork_state --> cancel_process
      fork_state --> decision_process
      fork_state --> error_process

%% state diagram
    %% Request job
    [*] --> create


    %% Run task
    decision_process --> background_choice
	background_choice --> backup_process : No, start process in foreground
	background_choice --> enqueue : Yes, enqueue in background

    enqueue --> backup_process
    backup_process --> backup_choice
    backup_choice --> backup : Yes, backup
    backup_choice --> working : No, go to work
    backup --> working : Start work
    working --> waiting : Resource constraint
    waiting --> working : Retry job
    working --> completed : Completed - Success
    working --> partial : Completed - Partial Success
    completed --> [*]
    partial --> [*]


    cancel_process --> cancel_choice : Yes
    cancel_choice --> queued_process
    cancel_choice --> cancel_process : No, listen for cancel

    queued_process --> queued_choice
    queued_choice --> dequeued : Yes, dequeue job
    queued_choice --> canceling : No, cancel work

    canceling --> restore_process
    restore_process --> restore_choice
    restore_choice --> restore : Backup exists, restore
    restore_choice --> canceled :  Completed - Canceled Work
    restore --> canceled  : Completed - Canceled Work and Restored Previous State
    dequeued --> canceled : Completed - Dequeued Job
    canceled --> [*]

    error_process --> error_choice : Yes
    error_choice --> fail : Yes, Completed - Failure Error
    error_choice --> timeout : Yes, Incomplete - Failure Time Out
    error_choice--> error_process : No, listen for error

    fail --> [*]
    timeout --> retry_process
    retry_process --> retry_choice
    retry_choice --> retry : Yes, queue to try again
    retry_choice --> retry_process : No, listen for retry
    retry --> enqueue

Entity Deletion — Document History

Tracks document-level entity deletion results, including successful deletions and partial completions where some documents were skipped.

Type	Description
Completed	Job <CPY_TAG_LABEL>{{job_id}}</CPY_TAG_LABEL> deleted $t(raw_entities, {“count”: {{raw_entities}} }).
Partially Completed	Job <CPY_TAG_LABEL>{{job_id}}</CPY_TAG_LABEL> deleted $t(documents, {“count”: {{documents}} }) ({{val, list}}) and skipped deleting $t(documents, {“count”: {{documents}} }) ({{val, list}}).

Click here to see the Document History activity flow. ↕

---
title: Audio Transcription
---
stateDiagram-v2
%% UX Text
completed : Completed
completed : Completed
completed.delete_entity_success : Job <CPY_TAG_LABEL>{{job_id}}</CPY_TAG_LABEL> deleted $t(raw_entities, {"count" {{raw_entities}} }).
partial : Partially Completed
partial : Partially Completed
partial.delete_entity_skipped : Job <CPY_TAG_LABEL>{{job_id}}</CPY_TAG_LABEL> deleted $t(documents, {"count" {{documents}} }) ({{val, list}}) and skipped deleting $t(documents, {"count" {{documents}} }) ({{val, list}}).
    results_process : Was the transcription successful?

%% choices
	state results_choice <<choice>>

%% states
  state completed {
    direction LR
    completed.delete_entity_success
  }
  state partial {
    direction LR
    partial.delete_entity_skipped

  }

%% state diagram
    %% Request job
    results_process --> results_choice
    results_choice --> completed : Yes
    results_choice --> partial : Partially