Changeset 4307


Ignore:
Timestamp:
May 21, 2008, 5:29:24 PM (13 years ago)
Author:
Martin Svensson
Message:

References #532. Written main part of the Job section

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/userdoc/jobs.xml

    r3679 r4307  
    55<!--
    66  $Id$
    7 
     7 
    88  Copyright (C) 2007 Jari Hakkinen, Peter Johansson, Martin Svensson
    9 
     9 
    1010  This file is part of BASE - BioArray Software Environment.
    1111  Available at http://base.thep.lu.se/
    12 
     12 
    1313  BASE is free software; you can redistribute it and/or
    1414  modify it under the terms of the GNU General Public License
    1515  as published by the Free Software Foundation; either version 2
    1616  of the License, or (at your option) any later version.
    17 
     17 
    1818  BASE is distributed in the hope that it will be useful,
    1919  but WITHOUT ANY WARRANTY; without even the implied warranty of
    2020  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    2121  GNU General Public License for more details.
    22 
     22 
    2323  You should have received a copy of the GNU General Public License
    2424  along with this program; if not, write to the Free Software
     
    3030  <?dbhtml dir="jobs"?>
    3131  <title>Jobs</title>
    32     <sect1>
    33       <title></title>
    34       <para></para>
    35     </sect1>
     32  <param>
     33    Job is a configured task performed by a plugin. Creating/configuring a job is done from a
     34    context that is supported by the plugin you want to use. Some jobs can be configured to
     35    execute immediately (for a few it is not even an option), but normally the jobs are placed
     36    in a queue after they have been configured. The order, in which the queued jobs are
     37    executed, is decided by the priority between the jobs and when there is a slot available to
     38    execute the job on. The priority can not be changed by a user, this is something that is
     39    specified by the plugin developer.
     40  </param>
     41
     42  <sect1 id="jobs.properties">
     43    <title>View a job</title>
     44    Go to
     45    <menuchoice>
     46      <guimenu>View</guimenu>
     47      <guimenuitem>Jobs</guimenuitem>
     48    </menuchoice>
     49    to list your jobs.
     50    <para>
     51      When viewing details of a single job, it is displayed in pop-up window. This window
     52      opens either if you click on a job's name from the list page of jobs or when a job
     53      configuration is finished. The window contains two tabs, one tab with information about
     54      the job and another with the parameters for the plugin used in the job.
     55    </para>
     56    <helptext external_id="job.view.parameters" title="Job parameters">
     57      <para>
     58        The values listed on the parameter-tab are used when running the job. Exactly which
     59        parameters to find here, is decided by the plugin and what inputs it needs from the
     60        user.
     61      </para>
     62    </helptext>
     63    <helptext external_id="job.view.properties" title="Job properties">
     64      <para>
     65        All parameters are set either when configuring the job or by the system. No
     66        parameters can be edit after a job is created.
     67        <variablelist>
     68          <varlistentry>
     69            <term>
     70              <guilabel>Name</guilabel>
     71            </term>
     72            <listitem>
     73              <para>
     74                The name of the job is set in the last step of a job configuration.
     75              </para>
     76            </listitem>
     77          </varlistentry>
     78          <varlistentry>
     79            <term>
     80              <optional>
     81                <guilabel>Description</guilabel>
     82              </optional>
     83            </term>
     84            <listitem>
     85              <para>
     86                Description of the job. Like the name-property it can be set when
     87                configuring a job.
     88              </para>
     89            </listitem>
     90          </varlistentry>
     91          <varlistentry>
     92            <term>
     93              <guilabel>Priority</guilabel>
     94            </term>
     95            <listitem>
     96              <para>
     97                This is what priority the job should have in the job queue. It is
     98                defined by the used plugin and can not be changed by the user. The
     99                value is between 1 and 10, where 1 is the highest priority.
     100              </para>
     101            </listitem>
     102          </varlistentry>
     103          <varlistentry>
     104            <term>
     105              <guilabel>Status</guilabel>
     106            </term>
     107            <listitem>
     108              <para>
     109                This shows the status of the job, sometimes including a message from
     110                the plugin. Status is one of the following:
     111                <itemizedlist>
     112                  <listitem>
     113                    <para>
     114                      <emphasis>Not configured</emphasis>
     115                      -The plugin has not been configured and is not placed in
     116                      the job queue.
     117                    </para>
     118                  </listitem>
     119                  <listitem>
     120                    <para>
     121                      <emphasis>Waiting</emphasis>
     122                      -Waiting in the job queue
     123                    </para>
     124                  </listitem>
     125                  <listitem>
     126                    <para>
     127                      <emphasis>Executing</emphasis>
     128                      -Job is being executed.
     129                    </para>
     130                  </listitem>
     131                  <listitem>
     132                    <para>
     133                      <emphasis>Done</emphasis>
     134                      - Indicates that the job is finished.
     135                    </para>
     136                  </listitem>
     137                  <listitem>
     138                    <para>
     139                      <emphasis>Error</emphasis>
     140                      -The job was aborted cause of some error.
     141                    </para>
     142                  </listitem>
     143                  <listitem>
     144                    <para>
     145                      <emphasis>Preparing</emphasis>
     146                      -Doing some preparing tasks befor executing the job.
     147                    </para>
     148                  </listitem>
     149                  <listitem>
     150                    <para>
     151                      <emphasis>Aborting</emphasis>
     152                      -Job has received an abort signal and tries to abort the
     153                      work.
     154                    </para>
     155                  </listitem>
     156                </itemizedlist>
     157              </para>
     158            </listitem>
     159          </varlistentry>
     160          <varlistentry>
     161            <term>
     162              <guilabel>Percent complete</guilabel>
     163            </term>
     164            <listitem>
     165              <para>
     166                This shows the progress of the job. How detailed this is depends on
     167                how often the plugin reports it's progress.
     168              </para>
     169            </listitem>
     170          </varlistentry>
     171          <varlistentry>
     172            <term>
     173              <guilabel>Created</guilabel>
     174            </term>
     175            <listitem>
     176              <para>Time and date when the job was created.</para>
     177            </listitem>
     178          </varlistentry>
     179          <varlistentry>
     180            <term>
     181              <guilabel>Started</guilabel>
     182            </term>
     183            <listitem>
     184              <para>Time when the job left the job queue and started to run.</para>
     185            </listitem>
     186          </varlistentry>
     187          <varlistentry>
     188            <term>
     189              <guilabel>Ended</guilabel>
     190            </term>
     191            <listitem>
     192              <para>
     193                Time when the job ended to run. Either cause of it was finished or
     194                an error.
     195              </para>
     196            </listitem>
     197          </varlistentry>
     198          <varlistentry>
     199            <term>
     200              <guilabel>Running time</guilabel>
     201            </term>
     202            <listitem>
     203              <para>Time between when the job was started and ended.</para>
     204            </listitem>
     205          </varlistentry>
     206          <varlistentry>
     207            <term>
     208              <guilabel>Server</guilabel>
     209            </term>
     210            <listitem>
     211              <para>Name of the server, where the job was performed.</para>
     212            </listitem>
     213          </varlistentry>
     214          <varlistentry>
     215            <term>
     216              <guilabel>User</guilabel>
     217            </term>
     218            <listitem>
     219              <para>The user who created/configured the job.</para>
     220            </listitem>
     221          </varlistentry>
     222          <varlistentry>
     223            <term>
     224              <guilabel>Experiment</guilabel>
     225            </term>
     226            <listitem>
     227              <para>Name of the experiment which the job was configured within.</para>
     228            </listitem>
     229          </varlistentry>
     230          <varlistentry>
     231            <term>
     232              <guilabel>Plugin</guilabel>
     233            </term>
     234            <listitem>
     235              <para>The plugin to perform the job.</para>
     236            </listitem>
     237          </varlistentry>
     238          <varlistentry>
     239            <term>
     240              <guilabel>Configuration</guilabel>
     241            </term>
     242            <listitem>
     243              <para>Name of the plugin configuration that is used.</para>
     244            </listitem>
     245          </varlistentry>
     246        </variablelist>
     247      </para>
     248    </helptext>
     249  </sect1>
    36250</chapter>
Note: See TracChangeset for help on using the changeset viewer.