Changeset 3183


Ignore:
Timestamp:
Mar 12, 2007, 4:54:23 PM (15 years ago)
Author:
Martin Svensson
Message:

More documentation about import and export data

File:
1 edited

Legend:

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

    r3177 r3183  
    3030  <title>Import and export of data</title>
    3131  <para>
    32     BASE2 has possibilities to import and export data to be able to get data in and out from the
    33     program. Data has to be imported into BASE2 before it's possible to start working with it in
    34     the enviroment.
     32    To be able to work with data in BASE 2 it first has to be imported into the database before
     33    it can be used by/in the environment. The same is for working outside BASE with data in the
     34    database, it first has to be exported. These two actions, importing and exporting, are done
     35    through the plugin interface.
    3536  </para>
    3637  <para>
    3738    Different kinds of import and export plugins, depending on the data, are used to get
    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
     39    data/information in and out from the BASE 2's database. There is a collection of plugins,
     40    core plugins, that comes with the installation of BASE2 and are administrated by the
     41    administrator or a similar user that has at least write permission on plugins. The list with
     42    these core plugins can be found at
    4143    <ulink
    42       url="http://base.thep.lu.se/chrome/site/doc/admin/plugin_configuration/coreplugins.html">
     44      url="http://base.thep.lu.se/chrome/site/doc/admin/plugin_configuration/coreplugins.html#import">
     45      http://base.thep.lu.se/chrome/site/doc/admin/plugin_configuration/coreplugins.html#import
    4346    </ulink>
    44     . The
     47    . There are also  configuration examples for some of the core plugins.  The
    4548    <guibutton>Import</guibutton>
    4649    or
     
    6770      Click on
    6871      <guibutton>Import</guibutton>
    69       in the toolbar to import data into database. This will open a popup window where the
     72      in the toolbar to import data into BASE2's database. This will open a pop-up window where the
    7073      job, that shall perform the data import, is going to be configured. More about jobs and
    7174      what a job is can be found under
     
    7477    </para>
    7578    <sect2 id="import_export_data.import.plugin_fileformat">
    76       <title>Select plugin and fileformat</title>
     79      <title>Select plugin and file format</title>
    7780      <para>
    7881        The first thing to do when configuring a job is to set which import plugin and file
     
    8386
    8487      <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
     88        <title>Auto detect</title>
     89        <para>
     90          This option is set by default in both plugin- and file format drop down lists
     91          when the pop-up window appear and it lets the BASE2 plugin-interface to choose
    8992          plugin and file format by validating the file that contains the data that shall
    9093          be imported.
    9194        </para>
    9295        <note>
    93           <title>About autodetect</title>
     96          <title>About auto detect</title>
    9497          <para>
    95             Not all plugins support autodetection. Those who do are marked in the drop
     98            Not all plugins support auto detection. Those which do are marked in the drop
    9699            down list with a
    97100            <guilabel>X</guilabel>
     
    138141            <primary>current context</primary>
    139142          </indexterm>
    140           also, can be found in the popup window's dropdown-list with plugins . Select the
     143          also, can be found in the pop-up window's drop-down-list with plugins . Select the
    141144          appropriate import plugin for the job from this list. A short description about
    142145          what the selected plugin does can be found at the bottom of the frame. More
     
    176179      <title>Job parameters</title>
    177180      <para>
    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
     181        This window contains of one top line with the names of the selected plugin and
     182        configuration, a list with parameters to the left, area for input fields to the
     183        right and buttons to proceed with at the bottom. Which the parameters in the list
     184        are depends on the selected plugin and it's configuration. Common parameter for all
     185        import plugin is however the
    180186        <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.
    184       </para>
     187        parameter (already set if auto detect is used) which holds the file to import the
     188        data from. A click on a parameter in the list to will display an input field and a
     189        description to the right of the list. Parameters that have a
     190        <guilabel>X</guilabel>
     191        in front of their names has already a value set and those parameter, which names are
     192        marked with a rectangle, are required and need to be set before continuing with the
     193        job configuration. There will be an error message if not all required parameters had
     194        been set.
     195      </para>
     196      <para>
     197        Continue the job configuration by clicking on
     198        <guibutton>Next</guibutton>
     199        . In this window should information about the job be filled in, like name and
     200        description. Where name is required and need to have value. There is also an option
     201        if the user want to get a message or not after the job is done. A ticked check-box
     202        here will send a message to the owner, after the job finished, with information
     203        about how the job execution went.
     204      </para>
     205      <para>
     206        Clicking on
     207        <guibutton>Finish</guibutton>
     208        when everything is set will end the job configuration and place the job in the BASE
     209        2 server's job queue. A self-refreshing window appears with information about the
     210        job's status and execution time. The job isn't dependent on the status window to run
     211        and therefore can it be closed without interrupting the execution.
     212      </para>
     213      <tip>
     214        <title>View job status</title>
     215        <para>
     216          A job's status can be viewed at any time by opening it from the job list page,
     217          <menuchoice>
     218            <guimenuitem>View</guimenuitem>
     219            <guimenuitem>Jobs</guimenuitem>
     220          </menuchoice>
     221          .
     222        </para>
     223      </tip>
    185224    </sect2>
    186225  </sect1>
     
    188227  <sect1 id="import_export_data.export">
    189228    <title>Export</title>
    190     <para></para>
    191 
     229    <para>
     230      Before data from BASE 2's database can be used outside the program, it first had to be
     231      exported to a file which then can be downloaded to a local path from the BASE
     232      file system.
     233    </para>
     234    <para>
     235      A data export is done by a job that runs an export plugin for the current context. Click
     236      on
     237      <guibutton>Export...</guibutton>
     238      in the toolbar, this will open a pop-up window where the job can be configured. The first
     239      thing in the configuration process is to choose what plugin the job should use and a
     240      configuration, for those plugins that require that. More information about the export
     241      plugins can be read in each plugin's documentation, except for the standard table
     242      exporter that is described further down on this page. The list of export plugins that
     243      are included in the current installation of BASE 2 can be found at
     244      <ulink
     245        url="http://base.thep.lu.se/chrome/site/doc/admin/plugin_configuration/coreplugins.html#export">
     246        http://base.thep.lu.se/chrome/site/doc/admin/plugin_configuration/coreplugins.html#export
     247      </ulink>
     248    </para>
     249    <para>
     250      Click on
     251      <guibutton>Next</guibutton>
     252      to show the configuration of parameters for the job. Common for all export plugins is
     253      the file parameter that decide where the export data should be saved. Some plugins
     254      support the option of download immediately which let the user to download the exported
     255      data to a local file system, by leaving the file parameter empty. For saving the
     256      exported data within the file system of BASE, it's recommended to use the
     257      <guibutton>Browse...</guibutton>
     258      button to get the right path and then complement it with the file's name.
     259    </para>
     260    <para>
     261      Click on
     262      <guibutton>Next</guibutton>
     263      to proceed to next configuration window.
     264    </para>
     265    <para>
     266      If the file parameter were left empty and immediately download was chosen the new window
     267      will have a
     268      <guibutton>Download</guibutton>
     269      button to specify where the data should be saved on the local computer.
     270    </para>
     271    <para>
     272      But if the file should be saved within the file system of BASE instead, there will be a
     273      window where the job should get a name and optionally a description. By then clicking on
     274      <guibutton>Finish</guibutton>
     275      the configuration process will end and the job will be put in the job queue. A
     276      self-refreshing window appears with information about the job's status and execution
     277      time. The job isn't dependent on the status window to run and it therefore be closed
     278      without interrupting the execution of the job.
     279    </para>
     280    <tip>
     281      <title>View job status</title>
     282      <para>
     283        A job's status can be viewed at any time by opening it from the job list page,
     284        <menuchoice>
     285          <guimenuitem>View</guimenuitem>
     286          <guimenuitem>Jobs</guimenuitem>
     287        </menuchoice>
     288        .
     289      </para>
     290    </tip>
    192291    <sect2 id="import_export_data.export.table_export">
    193292      <title>Table export</title>
    194293      <para>
    195 
    196       </para>
     294        The table exporter is a common export plugin for all list pages in BASE 2 and it
     295        makes it possible for the user to export the list to either a XML-file or a
     296        tab-separated text file. The table exporter supports all list pages and is started,
     297        like the other export plugins, by clicking on
     298        <guibutton>Export...</guibutton>
     299        in the toolbar.
     300      </para>
     301      <sect3 id="import_export_data.export.table_export.configuration">
     302        <title>Configuration</title>
     303        <para>
     304          Clicking on
     305          <guibutton>Export...</guibutton>
     306          will open a pop up window to configure the job in. If there are more plugins
     307          then the table exporter that support the current context, the first thing to do
     308          then is to choose which plugin to use - in this case
     309          <guilabel>Table exporter</guilabel>
     310          . Confirm the choice and go to next window by clicking on
     311          <guibutton>Next</guibutton>
     312          .
     313        </para>
     314        <para>
     315          In this window should the options to use in table exporter be set. See the list
     316          below for more information about each option.
     317          <variablelist>
     318            <title>Export options</title>
     319            <varlistentry>
     320              <term>
     321                <guilabel>Format</guilabel>
     322              </term>
     323              <listitem>
     324                <para>
     325                  The generated file can be either a tab-separated text file or a
     326                  XML file. In the text file will the columns be tab separated and
     327                  each row represent a row in the list. The XML-file option will
     328                  generate a tag for each item and these will contain a child tag
     329                  with property value for each selected column.
     330                </para>
     331              </listitem>
     332            </varlistentry>
     333            <varlistentry>
     334              <term>
     335                <guilabel>Which items?</guilabel>
     336              </term>
     337              <listitem>
     338                <para>
     339                  This option decide which items that should be included in the
     340                  exported data.
     341                  <itemizedlist>
     342                    <listitem>
     343                      <para>
     344                        Selected items(only available if items have been
     345                        selected on the list page). Only selected items will
     346                        be exported to the file.
     347                      </para>
     348                    </listitem>
     349                    <listitem>
     350                      <para>
     351                        Current page. Exports all items viewed on the
     352                        current list page.
     353                      </para>
     354                    </listitem>
     355                    <listitem>
     356                      <para>
     357                        All pages. Items on all pages will be exported to
     358                        the file.
     359                      </para>
     360                    </listitem>
     361                  </itemizedlist>
     362                </para>
     363              </listitem>
     364            </varlistentry>
     365            <varlistentry>
     366              <term>
     367                <guilabel>Which columns?</guilabel>
     368              </term>
     369              <listitem>
     370                <para>
     371                  Names of those columns that should be included in the export
     372                  should be listed in the left list-box. A column name is moved to
     373                  the other list-box by first marking it and then clicking on one
     374                  of the buttons located between the list-boxes.
     375                </para>
     376                <para>
     377                  The order in which the columns should be exported in can be
     378                  changed with the buttons to the left of the list. Simply mark a
     379                  name of a column and click on the buttons to move the name
     380                  either up or down in the list.
     381                </para>
     382                <tip>
     383                  <title>Using presets</title>
     384                  <para>
     385                    Use the drop down list of presets, located under the option
     386                    name, to easily get predefined or own presets of column
     387                    settings.
     388                  </para>
     389                </tip>
     390              </listitem>
     391            </varlistentry>
     392            <varlistentry>
     393              <term>
     394                <guilabel>Save as</guilabel>
     395              </term>
     396              <listitem>
     397                <para>
     398                  The last option is where the file with the exported data should
     399                  be saved. Leave the text field empty if the file is to be
     400                  downloaded immediately or enter a path within base2's file system
     401                  to store the file on the server. Check
     402                  <guilabel>Overwrite existing file</guilabel>
     403                  if an already existing file with the same name should be
     404                  overwritten. Click on
     405                  <guibutton>Ok</guibutton>
     406                  to proceed when all options have been set for the export.
     407                </para>
     408              </listitem>
     409            </varlistentry>
     410          </variablelist>
     411        </para>
     412        <para>
     413          The rest of the configuration process is the same as for all the other export
     414          plugins
     415        </para>
     416      </sect3>
    197417    </sect2>
    198418  </sect1>
Note: See TracChangeset for help on using the changeset viewer.