AtoM relies on Gearman in order to execute certain long-running tasks asynchronously to guarantee that web requests are handled promptly and work loads can be distributed across multiple machines. This ensures time and/or resource-intensive tasks do not timeout when running via the web browser.
You must have the necessary dependencies installed and configured to be able manage asynchronous jobs in AtoM. See: Asynchronous jobs and worker management.
Prior to AtoM 2.2, only the ingest of Archivematica DIPs was processed asynchronously. See Upload DIP for more details.
As of AtoM 2.2, the ability to generate PDF or RTF finding aids from archival descriptions, and the ability to manage PREMIS rights inheritance, are now also handled as asynchronous jobs in AtoM.
Users can see the status of job requests by navigating to Manage > Jobs.
Using the Jobs page¶
When first arriving on the page, users will see a table showing the status of any ongoing jobs, as well as any previous jobs that have not been cleared by another user. See below for more information on permissions and the Manage jobs page.
Start date: When the job was first requested.
End date: When the job completed. A status of “N/A” implies that the job is still executing.
Job name: Indicates the type of job being performed.
- arGenerateFindingAid - Generate a finding aid in either PDF or RTF format from an archival description. See: Generate, download, and print finding aids.
- Inherit rights - Allow child descriptions to inherit the PREMIS rights applied to a parent. See: Manage rights inheritance.
Job status: Jobs can have 1 of 3 statuses:
- Running - The job is currently being executed. Refresh the page for an updated status.
- Completed - The job completed successfully.
- Error - The job failed to complete as requested. If there is any further information, it will be included in the “Info” column of the Jobs table.
Info: Provides any available additional information about the status of a job.
User: The username of the AtoM user who initiated the job.
The Jobs page also includes a tab that allows users to view only those jobs that are currently still being executed (e.g., a status of “Running”). This can be useful when a large number of jobs are being executed simultaneously, and/or the list of jobs has not been cleared in some time. Click on the blue hyperlink to switch the view from “All jobs” to “Active jobs”. AtoM will refresh the page and the table will be limited to the selected view.
Jobs and user permissions¶
Access to the Jobs page functionality is dependent on your user role. See User roles, Manage user accounts and user groups, and Edit permissions for more information on managing user roles in AtoM.
All authenticated (e.g. logged in) users can access the Jobs page. However, most users will only see jobs and be able to clear jobs which they have started. Only an administrator can see the status of all jobs - however, like all users, administrators can only clear jobs that belong to them.