Print this page
In this topic
A job is the highest level of work that a user or Ringtail can submit to the Ringtail Processing Framework (RPF) for processing. The jobs can be file processing operations, database operations, or other processing operations.
Jobs contain stages, which contain tasks. System administrators, portal administrators, and case administrators can view all jobs and associated stages and tasks in their system, portal, or case, respectively. Administrators can pause, restart, or cancel processing and queued jobs, and change the priority level for the RPF to process the job. Administrators can also add new jobs for processing.
On the processing dashboard, the Recent Jobs section lists currently processing and completed jobs.
Use the following procedure to view jobs.
1.On the Portal Home page, under Portal Management, click Processing.
The processing dashboard appears.
2.To view all jobs, click View all jobs. Or, in the navigation pane, click Jobs.
The following table describes the information on the Jobs page.
Note: For portal administrators, when organization security is enabled, the list of available items depends on portal administrator membership, if any, in provider or client organizations. To understand how organizations are managed in Ringtail, see Organizations. For a summary of how organization security affects portal access for each Ringtail user category, see Portal security table.
Column |
Description |
(Job status icon) |
Hover over the icon to view information about the status. |
Job ID |
The unique identification number assigned to a job. Hover over the ID to view the case in which the job was created. Click the ID to view the job's stages. |
Type |
The job category, which is a high-level description of the submitted job. |
Portal |
The name of the SQL Server database associated with the portal. Note: This may be different than the portal name. |
Organization |
The provider or client organization associated with the job. |
Case |
The case with which the job is associated. |
Priority |
The job's rank. This can be Low, High, or Immediate. If multiple jobs are scheduled to run at the same time, the job with the higher priority runs first. |
Start |
The date and time that the job started. |
Duration |
The amount of time it took to complete the job. |
Progress |
The job's processing progress, shown as a percentage. |
3.To view all jobs processed in the system, portal, or case, or that have processed in the last 7, 30, or 60 days, select an option on the View jobs menu.
Use the following procedure to view the details of a job.
1.On the Portal Home page, under Portal Management, click Processing.
2.In the navigation pane, click Jobs.
3.Click a Job ID number.
4.In the navigation pane, click Properties.
A stage is a collection of tasks that is associated with a job.
Use the following procedure to view job stages and stage properties.
1.On the Portal Home page, under Portal Management, click Processing.
2.In the navigation pane, click Jobs.
3.Click a Job ID number.
The following table describes the information on the Stages page.
Column |
Description |
(Stage status) |
Hover over the icon to view information about the status. |
Name |
The name of the stage. Click to view the stage's tasks. |
Tasks Completed |
The number of tasks completed out of the total number of tasks in the stage's queue. |
Duration |
The amount of time it took to process the stage. |
Start |
The date and time that the stage started. |
Progress |
The stage's processing progress, shown as a percentage. |
4.To view the stage's properties, click a stage name, and then click Properties in the navigation pane.
You can view a stage's XML input, which is the XML set that provides instructions for a particular stage. You can also view the XML output produced for the previous stage. This information is useful when troubleshooting jobs, as some workers have a stage that depends on a previous stage's worker.
Use the following procedure to view a stage's input and output detail.
1.To open the Stages page, do the following:
a.On the Portal Home page, under Portal Management, click Processing.
b.In the navigation pane, click Jobs.
c.Click a Job ID number.
2.On the Stages page, click a stage name.
3.In the navigation pane, click XML.
A worker performs tasks when processing a job in the RPF. A task contains most of the information the worker needs to perform its function.
Use the following procedure to view the tasks of a stage.
1.To open the Stages page, do the following:
a.On the Portal Home page, under Portal Management, click Processing.
b.In the navigation pane, click Jobs.
c.Click a Job ID number.
2.On the Stages page, click a stage name.
The following table describes the information that appears on the Tasks page.
Column |
Description |
Task ID |
The unique number for the task. |
Start |
The date and time that the task started processing. |
Duration |
The amount of time it took to complete the task. |
Supervisor |
The name of the supervisor executing the task. |
Status |
The task's status. |
Progress |
The task's processing progress, shown as a percentage. |
3.To view task properties, click a task ID.
You can view a task's XML input, which is the XML set that provides instructions for performing a particular task. You can also view the XML output produced for tasks that succeeded with warnings. You can also view error data for tasks that encountered processing errors.
Note: Task output data is available only for stages that succeeded with warnings. Task error data is available only for tasks that failed or succeeded with warnings.
Use the following procedure to view a task's input and output detail.
1.To open the Stages page, do the following:
a.On the Portal Home page, under Portal Management, click Processing.
b.In the navigation pane, click Jobs.
c.Click a Job ID number.
2.On the Stages page, click a stage name.
3.On the Tasks page, click a Task ID.
4.In the navigation pane, click XML.
You can add the following job types for processing.
Job type |
Description |
Gather case metrics |
Scans the full file system to collect aggregate data about the case. The job reconciles files with Ringtail, including any folders that do not correspond to Ringtail levels. The data is then displayed in the Reports feature in Portal Management. For more information, see Portal Management Reports. Note: This job could take several hours for large cases with complex file system hierarchies. |
Indexing and enrichment |
Automatically runs the following tasks in the following order: 1.Page count, which calculates page counts and updates the database accordingly for any content file find documents and any documents with a null or 0 (zero) page count 2.Content file find 3.Optical character recognition (OCR) processing for documents without content files, if the OCR documents without content files option on the Case Options page is enabled 4.Indexing 5.Concept analysis 6.Search term families for families configured to run automatically 7.HTML extraction, excluding the following files: □Files with sizes over the limit specified in the Agent maximum file size option on the Portal Options page. □Files of standard image types, including the following file name extensions: .tiff, .tif, .jpg, .jpeg, .png, .gif, .bmp, .au, .snd, .wav, .mp3, .aif, .aiff, .aifc, .wma, .mpeg, .mpg, .mov, .mpe, .avi, .divx, .asx, .wmv, .movie, and .swf. 8.Gather case user metrics 9.Gather case aggregate metrics |
Search term family |
Processes all search term families in the case. Tip: To run a search term family job for one or more, but not all, search term families in a case, update families individually on the Search Term Families page in the case. |
Note: Because concept analysis now runs as part of indexing and enrichment jobs, previously scheduled concept analysis jobs are obsolete and should be removed. For information about how to remove a job, see Edit jobs.
For information about how to schedule a recurring job, see Work with scheduled jobs.
Use the following procedure to add a job.
1.On the Portal Home page, under Portal Management, click Processing.
2.In the navigation pane, click Jobs.
3.Click Add.
4.In the Add job dialog box, in the Job type list, select one of the following:
oGather case metrics
oIndexing and enrichment, and then select from the following options:
□Scan only level folders that have new documents or documents that have been submitted to refresh for indexing and enrichment. This option is selected by default.
□Scan all Ringtail level folders. Selecting this option will take longer than the previous option.
□Optionally, in the Indexing and enrichment dialog box, select the following check box:
♦Update case metrics: When selected, this option runs the case user metrics and case aggregate metrics stages of the job.
oSearch term family
5.Click Next.
6.Under Start time, select the date and time to start the job, and then click Next.
7.On the Cases page, select the cases for which you want to add the job, and then click Finish.
The new jobs appear on the Jobs page.
You can edit jobs that are currently processing, paused, or queued for processing. Editing entails pausing, restarting, or cancelling jobs. You can also reset a job's processing priority level. You cannot edit completed jobs, including failed and succeeded with warnings jobs.
Use the following procedure to edit a job.
1.On the Portal Home page, under Portal Management, click Processing.
2.In the navigation pane, click Jobs.
3.Select the check box next to one or more processing, paused, or queued jobs.
4.Click Edit.
5.Do one of the following:
oTo pause the job, select Pause.
oTo restart a paused job, select Restart.
oTo cancel the job, select Cancel.
Caution: You cannot restart a cancelled job.
6.To change the priority in which the job is processed, under Priority, select the new level.
7.Click Save.
