source: trunk/doc/src/docbook/userdoc/jobs.xml @ 4307

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC 
    "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
    "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
<!--
  $Id: jobs.xml 4307 2008-05-21 15:29:24Z martin $
  
  Copyright (C) 2007 Jari Hakkinen, Peter Johansson, Martin Svensson
  
  This file is part of BASE - BioArray Software Environment.
  Available at http://base.thep.lu.se/
  
  BASE is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.
  
  BASE is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330,
  Boston, MA  02111-1307, USA.
-->

<chapter id="jobs">
  <?dbhtml dir="jobs"?>
  <title>Jobs</title>
  <param>
    Job is a configured task performed by a plugin. Creating/configuring a job is done from a
    context that is supported by the plugin you want to use. Some jobs can be configured to
    execute immediately (for a few it is not even an option), but normally the jobs are placed
    in a queue after they have been configured. The order, in which the queued jobs are
    executed, is decided by the priority between the jobs and when there is a slot available to
    execute the job on. The priority can not be changed by a user, this is something that is
    specified by the plugin developer.
  </param>

  <sect1 id="jobs.properties">
    <title>View a job</title>
    Go to
    <menuchoice>
      <guimenu>View</guimenu>
      <guimenuitem>Jobs</guimenuitem>
    </menuchoice>
    to list your jobs.
    <para>
      When viewing details of a single job, it is displayed in pop-up window. This window
      opens either if you click on a job's name from the list page of jobs or when a job
      configuration is finished. The window contains two tabs, one tab with information about
      the job and another with the parameters for the plugin used in the job.
    </para>
    <helptext external_id="job.view.parameters" title="Job parameters">
      <para>
        The values listed on the parameter-tab are used when running the job. Exactly which
        parameters to find here, is decided by the plugin and what inputs it needs from the
        user.
      </para>
    </helptext>
    <helptext external_id="job.view.properties" title="Job properties">
      <para>
        All parameters are set either when configuring the job or by the system. No
        parameters can be edit after a job is created.
        <variablelist>
          <varlistentry>
            <term>
              <guilabel>Name</guilabel>
            </term>
            <listitem>
              <para>
                The name of the job is set in the last step of a job configuration.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <optional>
                <guilabel>Description</guilabel>
              </optional>
            </term>
            <listitem>
              <para>
                Description of the job. Like the name-property it can be set when
                configuring a job.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <guilabel>Priority</guilabel>
            </term>
            <listitem>
              <para>
                This is what priority the job should have in the job queue. It is
                defined by the used plugin and can not be changed by the user. The
                value is between 1 and 10, where 1 is the highest priority.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <guilabel>Status</guilabel>
            </term>
            <listitem>
              <para>
                This shows the status of the job, sometimes including a message from
                the plugin. Status is one of the following:
                <itemizedlist>
                  <listitem>
                    <para>
                      <emphasis>Not configured</emphasis>
                      -The plugin has not been configured and is not placed in
                      the job queue.
                    </para>
                  </listitem>
                  <listitem>
                    <para>
                      <emphasis>Waiting</emphasis>
                      -Waiting in the job queue
                    </para>
                  </listitem>
                  <listitem>
                    <para>
                      <emphasis>Executing</emphasis>
                      -Job is being executed.
                    </para>
                  </listitem>
                  <listitem>
                    <para>
                      <emphasis>Done</emphasis>
                      - Indicates that the job is finished.
                    </para>
                  </listitem>
                  <listitem>
                    <para>
                      <emphasis>Error</emphasis>
                      -The job was aborted cause of some error.
                    </para>
                  </listitem>
                  <listitem>
                    <para>
                      <emphasis>Preparing</emphasis>
                      -Doing some preparing tasks befor executing the job.
                    </para>
                  </listitem>
                  <listitem>
                    <para>
                      <emphasis>Aborting</emphasis>
                      -Job has received an abort signal and tries to abort the
                      work.
                    </para>
                  </listitem>
                </itemizedlist>
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <guilabel>Percent complete</guilabel>
            </term>
            <listitem>
              <para>
                This shows the progress of the job. How detailed this is depends on
                how often the plugin reports it's progress.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <guilabel>Created</guilabel>
            </term>
            <listitem>
              <para>Time and date when the job was created.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <guilabel>Started</guilabel>
            </term>
            <listitem>
              <para>Time when the job left the job queue and started to run.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <guilabel>Ended</guilabel>
            </term>
            <listitem>
              <para>
                Time when the job ended to run. Either cause of it was finished or
                an error.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <guilabel>Running time</guilabel>
            </term>
            <listitem>
              <para>Time between when the job was started and ended.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <guilabel>Server</guilabel>
            </term>
            <listitem>
              <para>Name of the server, where the job was performed.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <guilabel>User</guilabel>
            </term>
            <listitem>
              <para>The user who created/configured the job.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <guilabel>Experiment</guilabel>
            </term>
            <listitem>
              <para>Name of the experiment which the job was configured within.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <guilabel>Plugin</guilabel>
            </term>
            <listitem>
              <para>The plugin to perform the job.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>
              <guilabel>Configuration</guilabel>
            </term>
            <listitem>
              <para>Name of the plugin configuration that is used.</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </para>
    </helptext>
  </sect1>
</chapter>