Changeset 3177


Ignore:
Timestamp:
Mar 8, 2007, 4:45:41 PM (15 years ago)
Author:
Martin Svensson
Message:

Import data doc

File:
1 edited

Legend:

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

    r3165 r3177  
    44    "http://www.cs.put.poznan.pl/dweiss/dtd/dweiss-docbook-extensions.dtd">
    55<!--
    6   $Id:
     6  $Id$
    77 
    88  Copyright (C) Authors contributing to this file.
     
    3636  <para>
    3737    Different kinds of import and export plugins, depending on the data, are used to get
    38     data/information in and out from the database of BASE2. There are coreplugins that
    39     come with the installation of BASE2 and can be used by those that has
    40     permission to do so. A list of included coreplugins can be found at
     38    data/information in and out from the BASE 2's database. There are coreplugins that come with
     39    the installation of BASE2 and can be used by those that has permission to do so. A list of
     40    included coreplugins can be found at
    4141    <ulink
    4242      url="http://base.thep.lu.se/chrome/site/doc/admin/plugin_configuration/coreplugins.html">
    43     </ulink>.
    44     The <guibutton>Import</guibutton> or <guibutton>Export</guibutton>
    45     button will be available in a page's toolbar if the current item type is supported by one
    46     or many import and export plugins respectively that the logged in user has permission to use.
     43    </ulink>
     44    . The
     45    <guibutton>Import</guibutton>
     46    or
     47    <guibutton>Export</guibutton>
     48    button will be available in a page's toolbar if the current item type is supported by one or
     49    many import and export plugins respectively that the logged in user has permission to use.
    4750    <note>
    48       <title>Missing/unavailable plugin button</title>
     51      <title>Missing/unavailable button</title>
    4952      <para>
    50         The logged in user does usually not have enough permission on the actual plugin if
    51         the import- or export button is unavailable. Contact the administrator or similar user
    52         that has permission to administrate the plugins.
     53        The logged in user does usually not have enough permission on the expected plugin if
     54        the import- or export button is unavailable or not visible. Contact the
     55        administrator or similar user that has permission to administrate the plugins.
    5356      </para>
    5457    </note>
    5558  </para>
    5659  <para>
    57     Following subsections contains information how to go about when importing or exporting data in BASE2.
     60    Following subsections contains information how to go about when importing or exporting data
     61    in BASE2.
    5862  </para>
    5963
     
    6165    <title>Import</title>
    6266    <para>
     67      Click on
     68      <guibutton>Import</guibutton>
     69      in the toolbar to import data into database. This will open a popup window where the
     70      job, that shall perform the data import, is going to be configured. More about jobs and
     71      what a job is can be found under
     72      <xref linkend="jobs" />
     73      .
     74    </para>
     75    <sect2 id="import_export_data.import.plugin_fileformat">
     76      <title>Select plugin and fileformat</title>
     77      <para>
     78        The first thing to do when configuring a job is to set which import plugin and file
     79        format to use alternatively let the interface choose suitable plugin/fileformat,
     80        <xref linkend="import_export_data.import.plugin_fileformat.autodetect" />
     81        , based on the file that shall be imported.
     82      </para>
    6383
    64     </para>
     84      <sect3 id="import_export_data.import.plugin_fileformat.autodetect">
     85        <title>Autodetect</title>
     86        <para>
     87          This option is set by default in both plugin- and fil format drop down lists
     88          when the popup window appear and it lets the BASE2 plugin-interface to choose
     89          plugin and file format by validating the file that contains the data that shall
     90          be imported.
     91        </para>
     92        <note>
     93          <title>About autodetect</title>
     94          <para>
     95            Not all plugins support autodetection. Those who do are marked in the drop
     96            down list with a
     97            <guilabel>X</guilabel>
     98            .
     99          </para>
     100        </note>
     101        <para>
     102          Set either both plugins and file formats or only file format to auto detect.
     103          Click then on
     104          <guibutton>Next</guibutton>
     105          to go to the next window where the file to import from is selected. Press
     106          <guibutton>Browse...</guibutton>
     107          in this window to browse the BASE2 file system after the import file. If the
     108          file isn't in the file system it has to be uploaded first before it's possible
     109          to use it, read more about this under
     110          <xref linkend="file_system" />
     111          .
     112        </para>
    65113
    66     <sect2 id="import_export_data.import.plugins">
    67       <title>Plugins</title>
    68       <para>
     114        <para>
     115          Proceed by clicking on
     116          <guibutton>Next</guibutton>
     117          . If a file format and plugin compatible to the selected file could be found,
     118          the next window is where the job parameters should be configured and with the
     119          file parameter already set to the file that was selected earlier. Is there on
     120          the other hand no compatible file format or plugin found there will be an error
     121          message, that describes what went wrong.
     122        </para>
     123        <tip>
     124          <title>Recommendation</title>
     125          <para>
     126            Use the default settings, auto detect, to save clicks and configuration
     127            time.
     128          </para>
     129        </tip>
     130      </sect3>
    69131
    70       </para>
    71       <sect3 id="import_export_data.import.plugins.autodetect">
    72         <title>Auto detect</title>
     132      <sect3 id="import_export_data.import.plugin_fileformat.plugin">
     133        <title>Plugin</title>
    73134        <para>
     135          Available import plugins that the logged in user has permission to use and that
     136          support the
     137          <indexterm>
     138            <primary>current context</primary>
     139          </indexterm>
     140          also, can be found in the popup window's dropdown-list with plugins . Select the
     141          appropriate import plugin for the job from this list. A short description about
     142          what the selected plugin does can be found at the bottom of the frame. More
     143          information about the plugin can be found under the menu choice
     144          <menuchoice>
     145            <guimenu>Administrate</guimenu>
     146            <guimenuitem>Plugins</guimenuitem>
     147            <guisubmenu>Definitions</guisubmenu>
     148          </menuchoice>
     149        </para>
     150      </sect3>
    74151
     152      <sect3 id="import_export_data.import.plugin_fileformat.fileformat">
     153        <title>File format</title>
     154        <para>
     155          The drop down list of
     156          <indexterm>
     157            <primary>file format</primary>
     158          </indexterm>
     159          contains available file formats for the selected plugin. A file format configure
     160          a plugin how a import file should be parsed. Information about each file format
     161          can be found under the menu choice
     162          <menuchoice>
     163            <guimenu>Administrate</guimenu>
     164            <guimenuitem>Plugins</guimenuitem>
     165            <guisubmenu>Configurations</guisubmenu>
     166          </menuchoice>
     167        </para>
     168        <para>
     169          Proceed to next window by clicking on
     170          <guibutton>Next</guibutton>
    75171        </para>
    76172      </sect3>
    77173    </sect2>
    78174
    79     <sect2 id="import_export_data.import.fileformat">
    80       <title>File format</title>
     175    <sect2 id="import_export_data.import.jobparameters">
     176      <title>Job parameters</title>
    81177      <para>
    82 
     178        The contents of this window depends on what parameters the selected plugin need to
     179        know for running the job. Common for all import plugin is the
     180        <guilabel>File</guilabel>
     181        parameter (already set if autodetect is used) which holds the file to import data
     182        from. By clicking on a parameter in the list to left will display an input field and
     183        a description what it's for.
    83184      </para>
    84 
    85       <sect3 id="import_export_data.import.fileformat.autodetect">
    86         <title>Auto detect</title>
    87         <para>
    88 
    89         </para>
    90       </sect3>
    91185    </sect2>
    92186  </sect1>
Note: See TracChangeset for help on using the changeset viewer.