This is RenderMan 21 Documentation you are viewing. The Rmanwiki home page will redirect you to the current documentation.

Page tree

Contents

The Job List pane provides the primary interaction for the user to the Tractor jobs. It allows you to visualize which jobs are runing on the farm, sort and repriorize their queue order. You may also select jobs and remove them from the active job queue. Jobs are moved into an archive directory that can be accessed by other software.
 

Selections

The Job List pane will respond to several click and keystroke commands:

  • Select

    Simply click on a job and it will be selected. The task graph for the selected job will displayed on the right hand side in the Task Graph pane.

  • Multi-select

    Clicking with the Option key on Mac or Control key on Windows will add the current job to the selection list. If that job is already in the list, it will be removed.

    Clicking with the Shift key will select all jobs between the current selection and the last selection.

    The keyboard short cut using Control key with the A key will do a Select All operation. Note, depending upon the browser used, you may need to use a keyboard key that is not necessarily normal for the OS. For example, because the Macintosh browsers use Apple-A, you will need to use Control-A or Option-A instead.
     

  • Context-sensitive Menu

    Right-clicking will bring up a context sensitive menu that allow you to operate on the selected jobs. A subset of the possible menu items may be displayed, depending on the actions that are appropriate for the selected jobs. Not all menu items will be available in all cases.


     

  • Skip All Error Tasks

    Tasks that are stopped due to errors (non-zero command exits) will be ignored (forced to be marked as "Done") so that other tasks that were waiting on them can proceed. Usually errors are important to understand and address of course, but sometimes during testing it is valuable to continue past a known issue.
     

  • Retry All Error Tasks

    If a job has stopped due to errors, this command will tell the engine to retry the error tasks, and any other tasks that were blocked due to errors.
     

  • Retry Running Tasks

    Currently running tasks in the selected jobs will be cancelled and requeued.
     

  • Pause New Task Launches

    Tells the engine to pause the selected jobs. The active tasks will continue to run until complete, but no new tasks will be started.
     

  • Unpause & Resume Task Launches

    Tells the engine to unpause the selected jobs. Any previously paused jobs again become candidates for dispatching as blades become available.
     

  • Restart Job

    Tells the engine to rerun the job again, as if it had been freshly submitted to the job queue. Any running tasks will be canceled before the restart occurs. Any manual edits to job attributes will be reset to the as-spooled values.
     

  • Interrupt Job

    Tells the engine to pause the job and kill all of its active tasks.
     

  • Pin & Unpin Job

    Tells the engine that the Dashboard user wishes to pin or unpin the selected jobs. When a job is pinned, it will appear at the top of the job list, regardless of the sort column chosen. The selected sort column is effectively the secondary sort criteria, with the pin/unpin status of jobs being the primary. Pinning of jobs does not affect the display of jobs in other users' Dashboards.
     

  • Lock & Unlock Job

    Tells the engine to lock or unlock the selected Jobs. When a job is locked, only the user who locked the job is able to edit attributes of the job or perform operations on it. A wranagler may lock a job to prevent the job owner from deleting the job while a job is being debugged. Administrators may wish to lock critical jobs to ensure that they are not accidentally deleted.
     

  • Archive Job

    Tells the engine to remove selected jobs from the queue. Historical job information such as task execution history, command statistics, and job notes, will be accessible through the dashboard when the archived button is activated at the top of the job list.
     

  • Delete Job

    Tells the engine to remove selected jobs from the queue. Historical job information will be lost.
     

  • Shuffle Job To Top

    Tells the engine to rotate the "place in line" of the selected job with jobs of the same priority and same owner that were submitted earlier, causing the selected job to run sooner than it would in the default submission order. This rotation does not affect the ordering of other jobs on the queue that are of a different priority or owned by a different user.
     

  • Trace Job

    Requests a report from the engine describing how the job has been considered for scheduling. The results are displayed in a dedicated pane that appears over the job list pane. The tracer output pane can be closed by clicking on the 'x' icon in the top right corner or by pressing 'Esc'.
     

Keyboard Shortcuts

There are several keyboard shortcuts for managing the selected jobs:

  • Delete or Backspace

    Kills all active tasks of the selected jobs and remove those jobs from the queue. Deleted jobs cannot be viewed in the Dashboard in the job list, however, they can be seen in the Query Page by selecting include archives in search in the search menu.

     

  • R

    Retries all errored tasks of the selected jobs.

  • Ctrl/Command-A

    Selects all jobs.
     

  • Return/Enter

    Invokes 'yes' in dialogs.
     

  • Esc

    Invokes 'no' in dialogs. Closes the task log pane and tracer pane.
     

  • F5

    Refreshes the job list.
     

  • L

    Toggles the log view of the selected task.
     

  • A, B, D, E

    Selects the next active, blocked, done, or errored task in the job graph.
     

  • Shift + A, B, D, E

    Selects the previous active, blocked, done, or errored task in the job graph.
     

  • P

    Selects the parent task of the currently selected task in the job graph.
     

  • C

    Selects the first child task of currently selected task in the job graph.
     

  • S

    Selects the next sibling task of currently selected task in the job graph.
     

  • Shift + S

    Selects the previous sibling task of currently selected task in the job graph.
     

  • X

    Toggles the collapsing and expansion of the selected nodes in the job graph.
     

Archived Jobs

If the system has been configured to archive jobs, the job context menu will show Archive Job instead of Delete Job. To view archive jobs, press the current/archived button at the top of the job list so that archived is highlighted. The only operation that can be performed on an archived job is restore, which unarchives the job, moving it back to the current set of jobs.

Archiving or deleting jobs can help the system perform optimially, particularly for sites with hundreds of thousands of jobs.

When a job is archived, the historical job information such as task execution history, command statistics, and job notes are available for inspection.
 

Other UI Hints

  • Progress Bar

    The first column of the display contains a mini progress bar that indicates how far along the job is. The progress bar will display active jobs in green, and error jobs in red. Tasks waiting to execute are displayed in gray.
     

  • Selected Jobs

    When jobs are selected, the background color for that job will change to indicate that it has been selected.
     

  • Reload Timer

    The preferences panel contains an entry that defines the automatic reload interval, which by default is set to 600 seconds (10 minutes). An automatic refresh of the job data will occur at regular intervals defined by the value in the pull-down selector. The automatic refresh is advantageous when viewing the job list using a filter. Filters are applied by the engine, and the automatic reload keeps the job list synchronized more effectively.

    At large sites the amount of data returned from this query can be quite large, so a reload interval should be selected with care to avoid network bottlenecks.