====== Accessing and Interpreting Job Queue Information ======








===== How to Access Job Queue Information =====

To access the Fossology Software Repository Viewer **Show Jobs** screen:
   - Scroll to the bottom of the directory of folders/files shown in the left area of the Software Repository Viewer window.
   - Find **Show Jobs** (currently highlighted) and select it with your mouse. 

The **Show Jobs** screen will appear in the right-hand display area of the Software Repository Viewer window.  By default, job queue information is displayed when you select **Show Jobs**.  An example of this screen is shown below.  The meaning of the various parts of the screen is explained in the following sections.

{{fossology-job-window.png|}}
{{fossology-job-window-failedjob.png|}}

===== Switching between **Show Jobs** Screens =====

In the top right corner of this window, you can select from the following actions: 

__Update | show job history | show job queue__

  * Show job queue - This is the default screen that appears when you initially select Show Jobs.  This screen shows all the jobs in the jobs queue, and their current status.

  * Show Job History - This screen shows all jobs that have ever been run. (WARNING: This could be a very long list and take a long time to display.)

  * Update - Updates the Show Jobs screen currently being displayed with the latest information.

You can switch back and forth between screens by clicking on the screen type that that you want.


===== Interpreting the Information on the Show Job Queue screen =====


The initial default information in the Show Jobs frame displays unfinished jobs.





==== Color-coded Job Status ====

On both of the Show Jobs screens, the jobs displayed in the jobs queue are highlighted with one of the following status-related colors to show the current state of the job.

{{fossology-jobqueue-statusbar.png|}} 

These status colors have the following meaning:

  * queued - the job has been queued
  * ready - the job is ready to run, but not yet scheduled
  * scheduled - the job has been scheduled and/or is running
  * finished - the job has finished running
  * blocked  - the job has been blocked by a job on which it depends
  * failed -  the job has failed
  * no color - the job has not been queued

If you review the previous example of the Show Jobs window, you can see these status colors demonstrated for actual jobs.






==== Job Queue Table ====

{{fossology-jobque-tableheads.png|}}



Job queue information is displayed in a table that contains the following things about each job:

  * Job/Depends on - //Job// shows the job and job number. //Depends on// shows the dependency of the job upon completion of another job.
  * Agent - Shows the name of the package being analyzed and the associated agent (or agents) being run.
  * Status - Shows the latest status or result.
  * Job submission time - Shows the time that a job was submitted to the queue.
  * Agent end time - Shows the time that an Agent completed.


If you review the previous example of the Show Jobs window, you can see information under each heading for actual jobs.  

====== Software Repository Viewer File Upload Process ======

When you request the Viewer to upload a file, the following agents are scheduled and executed:

  * wget - gets the requested file from the specified source.
  * [[agents#unpack|unpack]] - extracts files to analyze.


Additionally, if the "License Analysis" box was checked in the "**Upload a File**" form, then the following agents are also scheduled and executed 

  * [[agents#filter_license|filter license]] - creates the bsam cache files.
  * [[agents#the_license_analysis_agent|license analysis]] - runs the bsam algorithm on the cache files. This generates the list of detected licenses.
  * [[agents#filter_clean|filter clean]] - purges the bsam cache files that are no longer needed.
  * [[agents#mimetype_agent|mimetype agent]] - associates a mime-type with every file.
  * [[agents#pkgmetagetta_agent|pkgmetagetta agent]] - extracts meta data from files.
  * [[agents#specagent_agent|specagent agent]] - is a special subset of pkgmetagetta and designed for extracting information from RPM “.spec” files.




NOTES:
  * The License Analysis box is checked by default.
  * The agents above will only run on files never seen before.  Files that already exist in the repository (for example, from a different software package which happens to use the exact same library files) will be skipped, since all the necessary information is already in the repository.
  * The scheduler checks for queued requests every 10 seconds.   
  * Agents are spawned by the scheduler according to commands in  the /usr/local/share/fossology/agents/scheduler.conf file.  
  * Agents spawned by the scheduler can be viewed by selecting "**Show Jobs**" from the left frame, as described in the [[interpret_the_job_queue|Interpret the Job Queue]] section.