Changeset 4309


Ignore:
Timestamp:
May 22, 2008, 3:51:05 PM (13 years ago)
Author:
Martin Svensson
Message:

References #532. Chapter is ready to be read.

File:
1 edited

Legend:

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

    r4307 r4309  
    3030  <?dbhtml dir="jobs"?>
    3131  <title>Jobs</title>
    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>
     32  <para>Job is a configured task performed by a plugin.</para>
     33  <para>
     34    Creating/configuring a job is made from a context, which is supported by the plugin you want
     35    to use. If no particularly context is needed, the job configuration is started from the
     36    plugin's single item view.
     37  </para>
     38  <para>
     39    Some jobs can be configured to execute immediately (for a few plugins it is mandatory that
     40    the job runs immediately), but normally jobs are placed in the job queue after they have
     41    been configured. The jobs will then be picked out for execution depending on their priority
     42    and estimated execution time.
     43  </para>
     44
    4145
    4246  <sect1 id="jobs.properties">
    43     <title>View a job</title>
    44     Go to
     47    <title>Properties</title>
     48    Click on
    4549    <menuchoice>
    4650      <guimenu>View</guimenu>
     
    4953    to list your jobs.
    5054    <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      Details of a single job is displayed in a pop-up window. This window opens either if you
     56      click on a job's name from the list page of jobs or when a job configuration is
     57      finished. The window contain two tabs, one with information about the job and another
     58      with the plugin-parameters for the plugin used in the job.
    5559    </para>
    5660    <helptext external_id="job.view.parameters" title="Job parameters">
    5761      <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.
     62        The values listed on the plugin-parameter-tab are depending on what inputs the
     63        choosen plugin needs from the user.
    6164      </para>
    6265    </helptext>
    6366    <helptext external_id="job.view.properties" title="Job properties">
    6467      <para>
    65         All parameters are set either when configuring the job or by the system. No
     68        Job-parameters are set either when configuring the job or by the system. No
    6669        parameters can be edit after a job is created.
    6770        <variablelist>
     
    8487            <listitem>
    8588              <para>
    86                 Description of the job. Like the name-property it can be set when
    87                 configuring a job.
     89                A description of the job. Like the name-property it can be set in
     90                the job configuration.
     91              </para>
     92            </listitem>
     93          </varlistentry>
     94          <varlistentry>
     95            <term>
     96              <guilabel>Type</guilabel>
     97            </term>
     98            <listitem>
     99              <para>
     100                The type of job, which is depending on the plugin that is used. It
     101                can be one of these five:
     102                <itemizedlist>
     103                  <listitem>Export</listitem>
     104                  <listitem>Import</listitem>
     105                  <listitem>Analysis</listitem>
     106                  <listitem>Intensity</listitem>
     107                  <listitem>Other</listitem>
     108                </itemizedlist>
    88109              </para>
    89110            </listitem>
     
    94115            </term>
    95116            <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>
     117              <para>Priority the job has in the job queue.</para>
    101118            </listitem>
    102119          </varlistentry>
     
    107124            <listitem>
    108125              <para>
    109                 This shows the status of the job, sometimes including a message from
    110                 the plugin. Status is one of the following:
     126                Shows the status of the job. A job can have one of following status.
    111127                <itemizedlist>
    112128                  <listitem>
    113129                    <para>
    114130                      <emphasis>Not configured</emphasis>
    115                       -The plugin has not been configured and is not placed in
    116                       the job queue.
     131                      -The plugin has not been configured properly and is not
     132                      placed in the job queue.
    117133                    </para>
    118134                  </listitem>
     
    120136                    <para>
    121137                      <emphasis>Waiting</emphasis>
    122                       -Waiting in the job queue
     138                      -Job is waiting in the job queue.
    123139                    </para>
    124140                  </listitem>
     
    160176          <varlistentry>
    161177            <term>
     178              <guilabel>Status message</guilabel>
     179            </term>
     180            <listitem>
     181              <para>
     182                A message, given by the plugin, with more information about the
     183                status.
     184              </para>
     185            </listitem>
     186          </varlistentry>
     187          <varlistentry>
     188            <term>
    162189              <guilabel>Percent complete</guilabel>
    163190            </term>
    164191            <listitem>
    165192              <para>
    166                 This shows the progress of the job. How detailed this is depends on
    167                 how often the plugin reports it's progress.
     193                Progress of the job. How detailed this is depends on how often the
     194                plugin reports it's progress.
    168195              </para>
    169196            </listitem>
     
    174201            </term>
    175202            <listitem>
    176               <para>Time and date when the job was created.</para>
     203              <para>
     204                Date and time when the job was created and registerd in the database.
     205              </para>
    177206            </listitem>
    178207          </varlistentry>
     
    182211            </term>
    183212            <listitem>
    184               <para>Time when the job left the job queue and started to run.</para>
     213              <para>
     214                Date and time when execution of the job started.
     215              </para>
    185216            </listitem>
    186217          </varlistentry>
     
    191222            <listitem>
    192223              <para>
    193                 Time when the job ended to run. Either cause of it was finished or
    194                 an error.
     224                Date and time when the job stopped running. Either cause of it was
     225                finished, aborted or interrupted by an error.
    195226              </para>
    196227            </listitem>
     
    201232            </term>
    202233            <listitem>
    203               <para>Time between when the job was started and ended.</para>
     234              <para>Time the job has been running.</para>
    204235            </listitem>
    205236          </varlistentry>
     
    214245          <varlistentry>
    215246            <term>
    216               <guilabel>User</guilabel>
     247              <guilabel>User/Owner</guilabel>
    217248            </term>
    218249            <listitem>
     
    233264            </term>
    234265            <listitem>
    235               <para>The plugin to perform the job.</para>
     266              <para>The plugin to use in the job.</para>
    236267            </listitem>
    237268          </varlistentry>
Note: See TracChangeset for help on using the changeset viewer.