FOSSology

h1. Overview of the FOSSology User Interface 

This chapter provides an overview of the default FOSSology User Interface (UI).  Detailed descriptions of FOSSology's functions are provided in additional sections of FOSSology documentation, which can be accessed from the [[user_documentation|User Docs]] contents page.

h2. FOSSology User Interface - Initial Screen 

The FOSSology User Interface (UI) initial screen is shown below.

When you first access the FOSSology UI - limited functionality is available until you log in to the interface.   An example of the initial FOSSology screen is shown below.  

!simple-notloggedin.png!

The functions that are provided to users who are not logged-in are:

  * Home - return to Home page

  * Help - get help using FOSSology

  * Login - log in to the full FOSSology UI

Depending on how the FOSSology site is administered and configured, users may also be able to search or browse.

  * Search - search the uploaded projects for specific files

  * Browse - browse the currently uploaded projects

Once you have logged in to the Fossolgy UI, you can access FOSSology's full functionality, as described in the following sections.

h2. Logging In to the UI 

You can log in to the FOSSology UI by clicking on the highlighted *login* item on the right side of the screen.  

The following login screen is displayed.  

!ui-menu-logging-in.png! 

Fill in the username/password information and then click the !login-button.png! button at the bottom of the screen.   

_*Notes: *_ 

  * Prior to being able to log in, you must possess an account on the FOSSology system.

  * *Username* and *Password* are required.

h2. FOSSology User Interface - After Logging In 

After you log in to the FOSSology user interface, the following screen is displayed.

!simple-menus-loggedin.png! 

h2. Getting Help 

The *Help* menu provides several topics about the FOSSology user interface.

!ui-menu-help.png!

h2. Finding License Information Using Browse 

The *Browse* tab provides a means of displaying analyzed license information in the fossology Respository.  

An example of the Browse screen is provided below.   

Note that the *Browse* screen provides folder navigation in the left-side window, and upload information in the right-side window.  By clicking on a folder and then on an upload, you can browse the repository and navigate to license information. 

Refer to the following documentation for detailed information about using the *Browse* functionality.

  * FIXME the links below need updating

  * [[How to Browse the Data-Base]] explains some basics about using the *Browse* functionality.

  * [[How to Find Analyzed License Information]] explains how to navigate through the license information provided by *Browse*.

!ui-menu-browse-v1.png!

h2. Uploading Files to Analyze 

FOSSology has many options for importing and uploading files for analysis. These options can be accessed from the *Upload* tab in the FOSSology UI.

!ui-menu-upload.png!

The options vary based on where the data to upload is located. The data can be uploaded from:

  * Your browser system - Use the *Upload -> From File* option to select and upload the file. While this can be very convenient (particularly if the file is not readily accessible online), uploading via your web browser can be slow for large files, and files larger than 650 Megabytes may not be uploadable.

     !simple-uploads.png! 

  * A remote server - Use the *Upload -> From URL* option to specify a remote server. This is the most flexible option, but the URL must denote a publicly accessible HTTP, HTTPS, or FTP location. URLs that require authentication or human interactions cannot be downloaded through this automated system.

     !url-uploads.png!

  * Use the *Upload -> One-Shot Analysis* option to upload a single file for license analysis (similar to upload from file). The analysis is done in real-time.  Note the limitations that are listed on the *One-Shot License Analysis* screen.

     !one-shot-uploads.png!

  * Use the *Upload -> One-Shot Copyright/Email/URL* option to upload a single file for copyright, email and URL analysis (similar to upload from file). The analysis is done in real-time.  Note the limitations that are listed on the *One-Shot Copyright/Email/URL* screen.

     !one-shot-analysis.png!

If your system is configured to use multiple agent servers, the data area must be mounted and accessible to the FOSSology user (fossy) on every agent system. See the section [[scheduler#Configuring the Scheduler]] in the [[Scheduler]] documentation. 

h2. Organizing FOSSology Data 

FOSSology provides many options for organizing license data and uploads.

You can access these options from the *Organize* tab in the FOSSology UI.

!ui-menu-organize-v1.png! 

h3. Organizing Folders 

In the *Organize > Folders* submenu, you can Create, Edit, and Move folders. Only administrators are allowed to delete folders.  There is no undelete, so folder removal is permanent.

!ui-menu-organize-folders-v1.png!

h3. Organizing Uploads 

The *Organize > Uploads* submenu provides the ability to move uploaded files and edit the properties of uploaded files. Only administrators are allowed to delete uploaded files. There is no undelete, so upload removal is permanent.

!ui-menu-organize-uploads-v1.png!

h2. Managing Jobs on the System 

The *Jobs* menu is used to manage FOSSology jobs and access FOSSology job information.

Within this menu, you can schedule an uploaded file for license analysis, and you can follow the progress of the analysis.

[[How to Interpret the Job Queue]] provides a description about interpreting and using the information provided by the *Jobs* functions.

!ui-menu-jobs.png! 

h3. Scheduling an Analysis 

The *Jobs>Agents* menu item provides access to the various FOSSology agents that perform the license analysis of files that have been uploaded to the FOSSology Repository.  In addition to scheduling a general license analysis, there are several specific types of analysis that can be performed.

!ui-menu-jobs-agents.png!

h3. MyJobs 

!ui-menu-myjobs.png!

The *MyJobs* function is designed to give the user a continuous status of their jobs by automatically updating the page every seven seconds. MyJobs provides less detail than the other job displays but provides a link to the *Jobs>Queue>Details*  page if more details are needed for a particular job.

h3. Getting Job Queue Information 

The *Jobs > Queue* menu provides access to job information in the following ways:

  * Job queue summary - See a short summary of jobs.

  * Job queue details - See detailed information about jobs.

  * Job queue information by upload - See scheduled jobs associated with an uploaded file.

The following fossology job information is provided:

  * Jobs that are Queued

  * Jobs that are Scheduled 

  * Jobs that are Running 

  * Jobs that are Finished 

  * Jobs that are Blocked 

  * Jobs that are Failed 

!ui-menu-jobs-queue.png!

h2. Performing Administrative Functions 

For details on how to administer FOSSology, see [[admin:Admin User Interface|Administering FOSSology]]

h2. Finding Files Using Search 

The search menu is an optional feature that by default is turned off.  The FOSSology administrator determines if search if available to users.  The feature is turned off by default because this feature allows anyone to search and display any material in the FOSSology system. Even if that material is not yours.  In the future FOSSology will change this feature to by default search only the users material.

If search is turned on, it will be visible when you are logged in.  See below.

!search-on.png!

Select the *Search* tab in the top menu to access the search screen.

If you know the name, or part of the name, of a file, you can search for it within the FOSSology Repository using the search mechanism on this screen.   Enter the search information into the text box, and click the *Search* button underneath it, to initiate a search.

!ui-menu-search.png!

If you select the *Advanced* search feature, additional search capabilities are provided, as shown in the following screen example:

!ui-menu-search-advanced.png!