What Is Work?
A long-running task, such as creating a PDF, is called Work.
Types of Work
The main types of Work are as follows.
Name | Description | Queued |
|---|---|---|
ExportPdfWork | Creates a PDF file | Yes |
ExportHtmlWork | Creates an HTML file | Yes |
ExportEpubWork | Creates an EPUB file | Yes |
ExportWordWork | Creates a Word file | Yes |
ExportLibraryHtmlWork | Creates an HTML file from a library | Yes |
CreateTagWork | Creates a tag | Yes |
CopyBookWork | Copies a document | Yes |
RemoveBookWork | Deletes a document | Yes |
ValidateBookWork | Validates a document | Yes |
DocumentStatisticsWork | Analyzes document statistics | Yes |
ImportXmlBookWork | Imports a document | Yes |
CreateVectorStoreWork | Creates a vector store | Yes |
UserEncryptionWork | Encrypts user names and email addresses | Yes |
MigrationWork | Migrates the database | Yes |
FileSystemClearWork | Checks files for cleanup | Yes |
UnusedUploadFindWork | Finds unused uploaded files | Yes |
UnusedUploadVerifyWork | Verifies unused uploaded files | Yes |
DownloadSoftwareUpdateWork | Downloads the software update file | No |
SearchBookWork | Searches documents | No |
SearchLibraryWork | Searches a library | No |
UnusedUploadRemoveWork | Quarantines unused uploaded files | No |
UnusedUploadRestoreWork | Restores unused uploaded files | No |
Queue
Supported starting with ManualWorks 6.0.5.
Because Work takes a long time, the number of Work items that can run at the same time is limited. Work waits its turn in a queue. However, the following tasks run immediately without entering the queue.
Downloading the software update file
Searching documents
Searching a library
Quarantining unused uploaded files
Restoring unused uploaded files
By default, three Work items can run at the same time. To change this, set 3rabbitz.work_manager_size in the startup script options. For details, see Setting Startup Script Options.
Monitoring Work
Supported starting with ManualWorks 6.0.5.
When you turn on monitoring, the <Admin | Servers | Work> menu appears. You can see Work that is running or waiting in the queue in real time.
Name | Description |
|---|---|
Name | The name of the Work |
Status | WAITING | STARTED | COMPLETED |
Create Time | When the Work was created |
Start Time | When the Work started after its turn came |
End Time | When the Work finished |
Waiting Time | Start Time - Create Time |
Run Time | End Time - Start Time |
Last Modified | When the progress was last checked for the progress bar. Work whose last modified time is later than its end time disappears from the list. Work that finished more than a minute ago also disappears from the list when EventCreatorScheduler runs. |