3157 |
05 Mar 07 |
martin |
1 |
<?xml version="1.0" encoding="UTF-8"?> |
3159 |
05 Mar 07 |
martin |
2 |
<!DOCTYPE chapter PUBLIC |
3200 |
21 Mar 07 |
martin |
3 |
"-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" |
3314 |
09 May 07 |
nicklas |
4 |
"../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd" |
3314 |
09 May 07 |
nicklas |
5 |
[ |
3314 |
09 May 07 |
nicklas |
6 |
<!ENTITY runplugin.configure.common |
3314 |
09 May 07 |
nicklas |
7 |
"The top of the window displays the names of the selected plug-in and |
3314 |
09 May 07 |
nicklas |
8 |
configuration, a list with parameters to the left, an area for input fields to the |
3314 |
09 May 07 |
nicklas |
9 |
right and buttons to proceed with at the bottom. |
3314 |
09 May 07 |
nicklas |
10 |
Click on a parameter in the parameter list to show the form fields |
3314 |
09 May 07 |
nicklas |
11 |
for entering values for the parameter to the right. Parameters |
3314 |
09 May 07 |
nicklas |
12 |
with an <guilabel>X</guilabel> in front of their names already have a |
3314 |
09 May 07 |
nicklas |
13 |
value. Parameters marked with a blue rectangle are required and must |
3314 |
09 May 07 |
nicklas |
14 |
be given a value before it is possible to proceed." |
3314 |
09 May 07 |
nicklas |
15 |
> |
3314 |
09 May 07 |
nicklas |
16 |
]> |
3157 |
05 Mar 07 |
martin |
17 |
<!-- |
3177 |
08 Mar 07 |
martin |
$Id$ |
3165 |
06 Mar 07 |
martin |
19 |
|
3675 |
16 Aug 07 |
jari |
Copyright (C) 2007 Peter Johansson, Nicklas Nordborg, Martin Svensson |
4889 |
06 Apr 09 |
nicklas |
Copyright (C) 2008 Jari Häkkinen |
3165 |
06 Mar 07 |
martin |
22 |
|
3157 |
05 Mar 07 |
martin |
This file is part of BASE - BioArray Software Environment. |
3157 |
05 Mar 07 |
martin |
Available at http://base.thep.lu.se/ |
3165 |
06 Mar 07 |
martin |
25 |
|
3157 |
05 Mar 07 |
martin |
BASE is free software; you can redistribute it and/or |
3157 |
05 Mar 07 |
martin |
modify it under the terms of the GNU General Public License |
4477 |
05 Sep 08 |
jari |
as published by the Free Software Foundation; either version 3 |
3157 |
05 Mar 07 |
martin |
of the License, or (at your option) any later version. |
3165 |
06 Mar 07 |
martin |
30 |
|
3157 |
05 Mar 07 |
martin |
BASE is distributed in the hope that it will be useful, |
3157 |
05 Mar 07 |
martin |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
3157 |
05 Mar 07 |
martin |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3157 |
05 Mar 07 |
martin |
GNU General Public License for more details. |
3165 |
06 Mar 07 |
martin |
35 |
|
3157 |
05 Mar 07 |
martin |
You should have received a copy of the GNU General Public License |
4509 |
11 Sep 08 |
jari |
along with BASE. If not, see <http://www.gnu.org/licenses/>. |
3157 |
05 Mar 07 |
martin |
38 |
--> |
4432 |
01 Sep 08 |
jari |
39 |
<chapter id="export_data" chunked="0"> |
5784 |
05 Oct 11 |
nicklas |
40 |
|
4432 |
01 Sep 08 |
jari |
41 |
<title>Export of data</title> |
3165 |
06 Mar 07 |
martin |
42 |
<para> |
4443 |
03 Sep 08 |
jari |
43 |
Before data stored in BASE can be used outside of BASE, the data must |
4432 |
01 Sep 08 |
jari |
44 |
first be exported to a file. When the export job finishes the file |
4432 |
01 Sep 08 |
jari |
45 |
can be downloaded from the BASE file system or optionally |
4432 |
01 Sep 08 |
jari |
46 |
downloaded immediately. Exporting data is possible for almost all |
4432 |
01 Sep 08 |
jari |
47 |
kind of data and the export is done by a job that runs an export |
4432 |
01 Sep 08 |
jari |
48 |
plug-in for the current context. An export job is started by |
4432 |
01 Sep 08 |
jari |
49 |
clicking on <guibutton>Export…</guibutton> in the toolbar, |
4432 |
01 Sep 08 |
jari |
50 |
the click action will open a pop-up window allowing you to select |
4432 |
01 Sep 08 |
jari |
51 |
plug-in and specify parameters for it. |
3165 |
06 Mar 07 |
martin |
52 |
</para> |
4432 |
01 Sep 08 |
jari |
53 |
|
3165 |
06 Mar 07 |
martin |
54 |
<para> |
4432 |
01 Sep 08 |
jari |
55 |
Normally, specific plug-ins handles different type of items, but |
4432 |
01 Sep 08 |
jari |
56 |
some plug-ins, for example the table exporter plug-in, can work |
4432 |
01 Sep 08 |
jari |
57 |
with several types of items. BASE ships with a number of export |
4432 |
01 Sep 08 |
jari |
58 |
plug-ins as a part of the core plug-ins package, |
4432 |
01 Sep 08 |
jari |
59 |
cf. <xref linkend="coreplugins.export" />. Go to |
3200 |
21 Mar 07 |
martin |
60 |
<menuchoice> |
3200 |
21 Mar 07 |
martin |
61 |
<guimenu>Administrate</guimenu> |
5784 |
05 Oct 11 |
nicklas |
62 |
<guimenuitem>Plug-ins & extensions</guimenuitem> |
5784 |
05 Oct 11 |
nicklas |
63 |
<guisubmenu>Plug-in definitions</guisubmenu> |
3200 |
21 Mar 07 |
martin |
64 |
</menuchoice> |
4432 |
01 Sep 08 |
jari |
65 |
to check which plug-ins are installed on your BASE server. When |
4432 |
01 Sep 08 |
jari |
66 |
BASE finds a plug-in that supports export of a certain type of |
4432 |
01 Sep 08 |
jari |
67 |
item an &gbExport; button is displayed in the toolbar on either |
4432 |
01 Sep 08 |
jari |
68 |
the list view or the single-item view. |
3200 |
21 Mar 07 |
martin |
69 |
</para> |
3200 |
21 Mar 07 |
martin |
70 |
<note> |
5784 |
05 Oct 11 |
nicklas |
71 |
<title>No "Export" button?</title> |
3200 |
21 Mar 07 |
martin |
72 |
<para> |
4432 |
01 Sep 08 |
jari |
73 |
If the export button is missing from a page were you would expect |
3314 |
09 May 07 |
nicklas |
74 |
to find them this usually means that: |
3200 |
21 Mar 07 |
martin |
75 |
</para> |
3314 |
09 May 07 |
nicklas |
76 |
<itemizedlist> |
3314 |
09 May 07 |
nicklas |
77 |
<listitem> |
3314 |
09 May 07 |
nicklas |
78 |
<simpara> |
3487 |
13 Jun 07 |
peter |
79 |
The logged in user does not have permission to use the plug-in. |
3314 |
09 May 07 |
nicklas |
80 |
</simpara> |
3314 |
09 May 07 |
nicklas |
81 |
</listitem> |
3314 |
09 May 07 |
nicklas |
82 |
<listitem> |
3314 |
09 May 07 |
nicklas |
83 |
<simpara> |
3314 |
09 May 07 |
nicklas |
84 |
The plug-in requires a configuration, but no one has been |
3487 |
13 Jun 07 |
peter |
85 |
created or the logged in user does not have permission to |
3314 |
09 May 07 |
nicklas |
86 |
use any of the existing configurations. |
3314 |
09 May 07 |
nicklas |
87 |
</simpara> |
3314 |
09 May 07 |
nicklas |
88 |
</listitem> |
3314 |
09 May 07 |
nicklas |
89 |
</itemizedlist> |
3314 |
09 May 07 |
nicklas |
90 |
<para> |
3314 |
09 May 07 |
nicklas |
91 |
Contact the server administrator or a similar user that has permission to |
3314 |
09 May 07 |
nicklas |
92 |
administrate the plug-ins. |
3314 |
09 May 07 |
nicklas |
93 |
</para> |
3200 |
21 Mar 07 |
martin |
94 |
</note> |
3314 |
09 May 07 |
nicklas |
95 |
|
4432 |
01 Sep 08 |
jari |
96 |
<sect1 id="import_export_data.export.selectplugin"> |
3314 |
09 May 07 |
nicklas |
97 |
<title>Select plug-in and configuration</title> |
3314 |
09 May 07 |
nicklas |
98 |
|
3208 |
23 Mar 07 |
martin |
99 |
<para> |
3314 |
09 May 07 |
nicklas |
100 |
This dialog is very similar to the dialog for selecting an |
3314 |
09 May 07 |
nicklas |
101 |
import plug-in. See <xref linkend="import_export_data.figures.select_import_plugin" /> |
3314 |
09 May 07 |
nicklas |
102 |
for a screenshot example. |
3208 |
23 Mar 07 |
martin |
103 |
</para> |
3314 |
09 May 07 |
nicklas |
104 |
|
3314 |
09 May 07 |
nicklas |
105 |
<helptext external_id="runplugin.selectplugin" title="Select plug-in"> |
3314 |
09 May 07 |
nicklas |
106 |
<para> |
3314 |
09 May 07 |
nicklas |
107 |
The first thing in the configuration process is to choose which plug-in |
3314 |
09 May 07 |
nicklas |
108 |
to use and a configuration for those plug-ins that require it. More |
3314 |
09 May 07 |
nicklas |
109 |
information about the plug-ins can be found in each plug-in's documentation. |
3314 |
09 May 07 |
nicklas |
110 |
</para> |
3314 |
09 May 07 |
nicklas |
111 |
<note> |
3314 |
09 May 07 |
nicklas |
112 |
If there is only one plug-in and configuration available, this |
3314 |
09 May 07 |
nicklas |
113 |
step is skipped and you are taken directly to next step. |
3314 |
09 May 07 |
nicklas |
114 |
</note> |
3314 |
09 May 07 |
nicklas |
115 |
|
3314 |
09 May 07 |
nicklas |
116 |
<variablelist> |
3314 |
09 May 07 |
nicklas |
117 |
<varlistentry> |
3314 |
09 May 07 |
nicklas |
118 |
<term> |
5372 |
24 Jun 10 |
nicklas |
119 |
<guilabel>Plugin + configuration</guilabel> |
3314 |
09 May 07 |
nicklas |
120 |
</term> |
3314 |
09 May 07 |
nicklas |
121 |
<listitem> |
3314 |
09 May 07 |
nicklas |
122 |
<para> |
5372 |
24 Jun 10 |
nicklas |
123 |
Select the plug-in and configuration to use. The list only |
5372 |
24 Jun 10 |
nicklas |
124 |
shows combinations that the logged in user has permission |
5372 |
24 Jun 10 |
nicklas |
125 |
to use. |
3314 |
09 May 07 |
nicklas |
126 |
</para> |
3314 |
09 May 07 |
nicklas |
127 |
</listitem> |
3314 |
09 May 07 |
nicklas |
128 |
</varlistentry> |
3314 |
09 May 07 |
nicklas |
129 |
</variablelist> |
3314 |
09 May 07 |
nicklas |
130 |
<para> |
3314 |
09 May 07 |
nicklas |
131 |
Click on |
3394 |
28 May 07 |
martin |
132 |
&gbNext; |
3314 |
09 May 07 |
nicklas |
133 |
to show the configuration of parameters for the job. |
3314 |
09 May 07 |
nicklas |
134 |
</para> |
3314 |
09 May 07 |
nicklas |
135 |
|
3314 |
09 May 07 |
nicklas |
136 |
<seeother> |
3314 |
09 May 07 |
nicklas |
137 |
<other external_id="runplugin.configure.export">Specify plug-in parameters</other> |
3314 |
09 May 07 |
nicklas |
138 |
</seeother> |
3314 |
09 May 07 |
nicklas |
139 |
</helptext> |
4432 |
01 Sep 08 |
jari |
140 |
</sect1> |
3314 |
09 May 07 |
nicklas |
141 |
|
4432 |
01 Sep 08 |
jari |
142 |
<sect1 id="import_export_data.export.pluginparameters"> |
3314 |
09 May 07 |
nicklas |
143 |
<title>Specify plug-in parameters</title> |
3314 |
09 May 07 |
nicklas |
144 |
|
3314 |
09 May 07 |
nicklas |
145 |
<helptext external_id="runplugin.configure.export" |
3314 |
09 May 07 |
nicklas |
146 |
title="Specify plug-in parameters"> |
3314 |
09 May 07 |
nicklas |
147 |
|
3314 |
09 May 07 |
nicklas |
148 |
<para> |
3314 |
09 May 07 |
nicklas |
149 |
&runplugin.configure.common; |
3314 |
09 May 07 |
nicklas |
150 |
</para> |
3314 |
09 May 07 |
nicklas |
151 |
|
3314 |
09 May 07 |
nicklas |
152 |
<para> |
3314 |
09 May 07 |
nicklas |
153 |
The parameters list is very different from plug-in to plug-in. |
3314 |
09 May 07 |
nicklas |
154 |
Common parameters for export plug-ins are: |
3314 |
09 May 07 |
nicklas |
155 |
</para> |
3314 |
09 May 07 |
nicklas |
156 |
|
3208 |
23 Mar 07 |
martin |
157 |
<variablelist> |
3208 |
23 Mar 07 |
martin |
158 |
<varlistentry> |
3314 |
09 May 07 |
nicklas |
159 |
<term><guilabel>Save as</guilabel></term> |
3208 |
23 Mar 07 |
martin |
160 |
<listitem> |
3208 |
23 Mar 07 |
martin |
161 |
<para> |
4432 |
01 Sep 08 |
jari |
162 |
The path and file name in the BASE file system where |
3314 |
09 May 07 |
nicklas |
163 |
the exported data should be saved. Some plug-ins support immediate |
3314 |
09 May 07 |
nicklas |
164 |
download to the local file system if you leave the file parameter |
3314 |
09 May 07 |
nicklas |
165 |
empty. For saving the exported data within the BASE file system, |
3314 |
09 May 07 |
nicklas |
166 |
it's recommended to use the <guibutton>Browse…</guibutton> |
3314 |
09 May 07 |
nicklas |
167 |
button to get the right path and then complement it with the file's name. |
3208 |
23 Mar 07 |
martin |
168 |
</para> |
3208 |
23 Mar 07 |
martin |
169 |
</listitem> |
3208 |
23 Mar 07 |
martin |
170 |
</varlistentry> |
3208 |
23 Mar 07 |
martin |
171 |
</variablelist> |
3208 |
23 Mar 07 |
martin |
172 |
<para> |
3208 |
23 Mar 07 |
martin |
173 |
Click on |
3394 |
28 May 07 |
martin |
174 |
&gbNext; |
3314 |
09 May 07 |
nicklas |
175 |
to proceed to next configuration window. |
3208 |
23 Mar 07 |
martin |
176 |
</para> |
3329 |
11 May 07 |
nicklas |
177 |
<seeother> |
3329 |
11 May 07 |
nicklas |
178 |
<other external_id="runplugin.configure">The plug-in configuration wizard</other> |
3329 |
11 May 07 |
nicklas |
179 |
</seeother> |
3314 |
09 May 07 |
nicklas |
180 |
|
3208 |
23 Mar 07 |
martin |
181 |
</helptext> |
3314 |
09 May 07 |
nicklas |
182 |
|
3314 |
09 May 07 |
nicklas |
183 |
<sect3 id="import_export_data.export.immediatedownload"> |
3314 |
09 May 07 |
nicklas |
184 |
<title>Immediate download of the exported data</title> |
3314 |
09 May 07 |
nicklas |
185 |
|
3314 |
09 May 07 |
nicklas |
186 |
<para> |
3314 |
09 May 07 |
nicklas |
187 |
If the selected plug-in supports immediate download and the file parameter |
4432 |
01 Sep 08 |
jari |
188 |
were left empty a new window with a <guibutton>Download</guibutton> |
3314 |
09 May 07 |
nicklas |
189 |
button is displayed. Click on this button to start the plug-in execution. |
3314 |
09 May 07 |
nicklas |
190 |
Do not close the window until a message saying that the export |
3314 |
09 May 07 |
nicklas |
191 |
was successful (or failed) is displayed. Your browser should open a dialog |
3314 |
09 May 07 |
nicklas |
192 |
asking you were to save the file on your local computer. |
3314 |
09 May 07 |
nicklas |
193 |
</para> |
3314 |
09 May 07 |
nicklas |
194 |
|
3314 |
09 May 07 |
nicklas |
195 |
<figure id="import_export_data.figures.download_immediately"> |
3314 |
09 May 07 |
nicklas |
196 |
<title>Download immediately</title> |
3314 |
09 May 07 |
nicklas |
197 |
<screenshot> |
3314 |
09 May 07 |
nicklas |
198 |
<mediaobject> |
3314 |
09 May 07 |
nicklas |
199 |
<imageobject><imagedata fileref="figures/download_immediately.png" format="PNG" /></imageobject> |
3314 |
09 May 07 |
nicklas |
200 |
</mediaobject> |
3314 |
09 May 07 |
nicklas |
201 |
</screenshot> |
3314 |
09 May 07 |
nicklas |
202 |
</figure> |
3314 |
09 May 07 |
nicklas |
203 |
|
3314 |
09 May 07 |
nicklas |
204 |
</sect3> |
3314 |
09 May 07 |
nicklas |
205 |
|
3314 |
09 May 07 |
nicklas |
206 |
<sect3 id="import_export_data.export.savetofilesystem"> |
3314 |
09 May 07 |
nicklas |
207 |
<title>Saving the exported data in the BASE file system</title> |
3314 |
09 May 07 |
nicklas |
208 |
|
3314 |
09 May 07 |
nicklas |
209 |
<para> |
3481 |
13 Jun 07 |
martin |
210 |
If you choose to save the file within the BASE file system, there will be a window |
3481 |
13 Jun 07 |
martin |
211 |
where the job should get a name and optionally a description. There are also two |
3481 |
13 Jun 07 |
martin |
212 |
check boxes in this window. |
3481 |
13 Jun 07 |
martin |
213 |
<variablelist> |
3481 |
13 Jun 07 |
martin |
214 |
<varlistentry> |
3481 |
13 Jun 07 |
martin |
215 |
<term> |
3481 |
13 Jun 07 |
martin |
216 |
<guilabel>Send message</guilabel> |
3481 |
13 Jun 07 |
martin |
217 |
</term> |
3481 |
13 Jun 07 |
martin |
218 |
<listitem> |
3481 |
13 Jun 07 |
martin |
219 |
<para> |
3481 |
13 Jun 07 |
martin |
220 |
Tick this check box if the job should send you a message when it is |
3481 |
13 Jun 07 |
martin |
221 |
finished, otherwise untick it |
3481 |
13 Jun 07 |
martin |
222 |
</para> |
3481 |
13 Jun 07 |
martin |
223 |
</listitem> |
3481 |
13 Jun 07 |
martin |
224 |
</varlistentry> |
3481 |
13 Jun 07 |
martin |
225 |
<varlistentry> |
3481 |
13 Jun 07 |
martin |
226 |
<term> |
3481 |
13 Jun 07 |
martin |
227 |
<guilabel>Remove job</guilabel> |
3481 |
13 Jun 07 |
martin |
228 |
</term> |
3481 |
13 Jun 07 |
martin |
229 |
<listitem> |
3481 |
13 Jun 07 |
martin |
230 |
<para> |
3481 |
13 Jun 07 |
martin |
231 |
If this is ticked, the job will be marked as removed when it is |
3481 |
13 Jun 07 |
martin |
232 |
finished, on condition that it was finished successfully. This is |
3481 |
13 Jun 07 |
martin |
233 |
only available for import- and export- plugins. |
3481 |
13 Jun 07 |
martin |
234 |
</para> |
3481 |
13 Jun 07 |
martin |
235 |
</listitem> |
3481 |
13 Jun 07 |
martin |
236 |
</varlistentry> |
3481 |
13 Jun 07 |
martin |
237 |
</variablelist> |
3481 |
13 Jun 07 |
martin |
238 |
By then clicking on &gbFinish; the configuration process will end and the job will |
3481 |
13 Jun 07 |
martin |
239 |
be put in the job queue. A self-refreshing window appears with information about the |
3487 |
13 Jun 07 |
peter |
240 |
job's status and execution time. The job is not dependent on the status window to run |
3481 |
13 Jun 07 |
martin |
241 |
and it therefore be closed without interrupting the execution of the job. |
3314 |
09 May 07 |
nicklas |
242 |
</para> |
3314 |
09 May 07 |
nicklas |
243 |
<tip> |
3314 |
09 May 07 |
nicklas |
244 |
<title>View job status</title> |
3314 |
09 May 07 |
nicklas |
245 |
<para> |
3314 |
09 May 07 |
nicklas |
246 |
A job's status can be viewed at any time by opening it from the job list page, |
3314 |
09 May 07 |
nicklas |
247 |
<menuchoice> |
3314 |
09 May 07 |
nicklas |
248 |
<guimenuitem>View</guimenuitem> |
3314 |
09 May 07 |
nicklas |
249 |
<guimenuitem>Jobs</guimenuitem> |
3314 |
09 May 07 |
nicklas |
250 |
</menuchoice>. |
3314 |
09 May 07 |
nicklas |
251 |
</para> |
3314 |
09 May 07 |
nicklas |
252 |
</tip> |
3314 |
09 May 07 |
nicklas |
253 |
</sect3> |
4432 |
01 Sep 08 |
jari |
254 |
</sect1> |
3314 |
09 May 07 |
nicklas |
255 |
|
4432 |
01 Sep 08 |
jari |
256 |
<sect1 id="import_export_data.export.table_export"> |
3314 |
09 May 07 |
nicklas |
257 |
<title>The table exporter plug-in</title> |
3183 |
12 Mar 07 |
martin |
258 |
<para> |
3314 |
09 May 07 |
nicklas |
259 |
The table exporter is a generic export plug-in that works with almost |
3314 |
09 May 07 |
nicklas |
260 |
all list views in BASE. It can export the lists as an XML-file or a |
3314 |
09 May 07 |
nicklas |
261 |
tab-separated text file. The table exporter is started, |
3314 |
09 May 07 |
nicklas |
262 |
like the other export plug-ins, by clicking on |
3314 |
09 May 07 |
nicklas |
263 |
<guibutton>Export…</guibutton> in the toolbar. |
3183 |
12 Mar 07 |
martin |
264 |
</para> |
3314 |
09 May 07 |
nicklas |
265 |
|
3183 |
12 Mar 07 |
martin |
266 |
<para> |
3314 |
09 May 07 |
nicklas |
267 |
Then select the <guilabel>Table exporter</guilabel> and click on |
3394 |
28 May 07 |
martin |
268 |
the &gbNext; button. The plug-in selection step is |
3314 |
09 May 07 |
nicklas |
269 |
only displayed if there is more than one export plug-in that can |
3314 |
09 May 07 |
nicklas |
270 |
be used in the current context. Usually, the table exporter is the |
3314 |
09 May 07 |
nicklas |
271 |
only plug-in and you will be take directly to the configuration |
3314 |
09 May 07 |
nicklas |
272 |
dialog. |
3183 |
12 Mar 07 |
martin |
273 |
</para> |
3314 |
09 May 07 |
nicklas |
274 |
|
3183 |
12 Mar 07 |
martin |
275 |
<para> |
3487 |
13 Jun 07 |
peter |
276 |
Unlike other plug-ins, the table exporter does not use the |
3314 |
09 May 07 |
nicklas |
277 |
generic parameter input dialog. It has a customized dialog |
3314 |
09 May 07 |
nicklas |
278 |
that should be easier to use. |
3183 |
12 Mar 07 |
martin |
279 |
</para> |
3314 |
09 May 07 |
nicklas |
280 |
|
3314 |
09 May 07 |
nicklas |
281 |
<figure id="import_export_data.figures.table_exporter"> |
3314 |
09 May 07 |
nicklas |
282 |
<title>The table exporter configuration dialog</title> |
3314 |
09 May 07 |
nicklas |
283 |
<screenshot> |
3314 |
09 May 07 |
nicklas |
284 |
<mediaobject> |
3314 |
09 May 07 |
nicklas |
285 |
<imageobject><imagedata fileref="figures/table_exporter.png" format="PNG" /></imageobject> |
3314 |
09 May 07 |
nicklas |
286 |
</mediaobject> |
3314 |
09 May 07 |
nicklas |
287 |
</screenshot> |
3314 |
09 May 07 |
nicklas |
288 |
</figure> |
3314 |
09 May 07 |
nicklas |
289 |
|
3314 |
09 May 07 |
nicklas |
290 |
|
3314 |
09 May 07 |
nicklas |
291 |
<helptext external_id="simpleexport.options" title="Export options"> |
3314 |
09 May 07 |
nicklas |
292 |
<variablelist> |
3314 |
09 May 07 |
nicklas |
293 |
<varlistentry> |
3314 |
09 May 07 |
nicklas |
294 |
<term> |
3314 |
09 May 07 |
nicklas |
295 |
<guilabel>Format</guilabel> |
3314 |
09 May 07 |
nicklas |
296 |
</term> |
3314 |
09 May 07 |
nicklas |
297 |
<listitem> |
3314 |
09 May 07 |
nicklas |
298 |
<para> |
3314 |
09 May 07 |
nicklas |
299 |
The generated file can be either a |
3314 |
09 May 07 |
nicklas |
300 |
<guilabel>tab-separated text file</guilabel> |
3314 |
09 May 07 |
nicklas |
301 |
or an <guilabel>XML</guilabel> file. The |
3314 |
09 May 07 |
nicklas |
302 |
XML-file option will generate a tag for each item and these |
3314 |
09 May 07 |
nicklas |
303 |
will contain a child tag with property value for each |
3314 |
09 May 07 |
nicklas |
304 |
selected column. |
3314 |
09 May 07 |
nicklas |
305 |
</para> |
3314 |
09 May 07 |
nicklas |
306 |
</listitem> |
3314 |
09 May 07 |
nicklas |
307 |
</varlistentry> |
3314 |
09 May 07 |
nicklas |
308 |
<varlistentry> |
3314 |
09 May 07 |
nicklas |
309 |
<term> |
3314 |
09 May 07 |
nicklas |
310 |
<guilabel>Which items?</guilabel> |
3314 |
09 May 07 |
nicklas |
311 |
</term> |
3314 |
09 May 07 |
nicklas |
312 |
<listitem> |
3314 |
09 May 07 |
nicklas |
313 |
<para> |
3314 |
09 May 07 |
nicklas |
314 |
This option decide which items that should be included in |
3314 |
09 May 07 |
nicklas |
315 |
the exported data. |
3314 |
09 May 07 |
nicklas |
316 |
<itemizedlist> |
3200 |
21 Mar 07 |
martin |
317 |
<listitem> |
3183 |
12 Mar 07 |
martin |
318 |
<para> |
3314 |
09 May 07 |
nicklas |
319 |
<guilabel>Selected items</guilabel>: |
3314 |
09 May 07 |
nicklas |
320 |
Only selected items will be exported. This options |
3314 |
09 May 07 |
nicklas |
321 |
is not available if no items have been |
3314 |
09 May 07 |
nicklas |
322 |
selected on the list page. |
3183 |
12 Mar 07 |
martin |
323 |
</para> |
3200 |
21 Mar 07 |
martin |
324 |
</listitem> |
3200 |
21 Mar 07 |
martin |
325 |
<listitem> |
3200 |
21 Mar 07 |
martin |
326 |
<para> |
3314 |
09 May 07 |
nicklas |
327 |
<guilabel>Current page</guilabel>: Exports all |
3314 |
09 May 07 |
nicklas |
328 |
items viewed on the current list page. |
3200 |
21 Mar 07 |
martin |
329 |
</para> |
3200 |
21 Mar 07 |
martin |
330 |
</listitem> |
3200 |
21 Mar 07 |
martin |
331 |
<listitem> |
3200 |
21 Mar 07 |
martin |
332 |
<para> |
3314 |
09 May 07 |
nicklas |
333 |
<guilabel>All pages</guilabel>: Items on all pages |
3314 |
09 May 07 |
nicklas |
334 |
will be exported. |
3200 |
21 Mar 07 |
martin |
335 |
</para> |
3200 |
21 Mar 07 |
martin |
336 |
</listitem> |
3314 |
09 May 07 |
nicklas |
337 |
</itemizedlist> |
3314 |
09 May 07 |
nicklas |
338 |
</para> |
3314 |
09 May 07 |
nicklas |
339 |
</listitem> |
3314 |
09 May 07 |
nicklas |
340 |
</varlistentry> |
3314 |
09 May 07 |
nicklas |
341 |
<varlistentry> |
3314 |
09 May 07 |
nicklas |
342 |
<term> |
3314 |
09 May 07 |
nicklas |
343 |
<guilabel>Which columns?</guilabel> |
3314 |
09 May 07 |
nicklas |
344 |
</term> |
3314 |
09 May 07 |
nicklas |
345 |
<listitem> |
3314 |
09 May 07 |
nicklas |
346 |
<para> |
3314 |
09 May 07 |
nicklas |
347 |
Names of those columns that should be included in the export |
3314 |
09 May 07 |
nicklas |
348 |
should be listed in the <guilabel>Exported columns</guilabel> |
3314 |
09 May 07 |
nicklas |
349 |
to the left. A column name is |
3314 |
09 May 07 |
nicklas |
350 |
moved to the other list-box by first marking it and then |
3314 |
09 May 07 |
nicklas |
351 |
clicking on one of the buttons located between the |
3314 |
09 May 07 |
nicklas |
352 |
list-boxes. |
3314 |
09 May 07 |
nicklas |
353 |
</para> |
3314 |
09 May 07 |
nicklas |
354 |
<para> |
3314 |
09 May 07 |
nicklas |
355 |
The order in which the columns should be exported in can be |
3314 |
09 May 07 |
nicklas |
356 |
changed with the buttons to the left of the list. Simply |
3314 |
09 May 07 |
nicklas |
357 |
mark a name of a column and click on the buttons to move the |
3314 |
09 May 07 |
nicklas |
358 |
name either up or down in the list. |
3314 |
09 May 07 |
nicklas |
359 |
</para> |
3314 |
09 May 07 |
nicklas |
360 |
<tip> |
3314 |
09 May 07 |
nicklas |
361 |
<title>Using presets</title> |
3314 |
09 May 07 |
nicklas |
362 |
<para> |
3314 |
09 May 07 |
nicklas |
363 |
Use the drop down list of presets, located under the |
3314 |
09 May 07 |
nicklas |
364 |
option name, to easily get predefined or own presets of |
3314 |
09 May 07 |
nicklas |
365 |
column settings. |
3314 |
09 May 07 |
nicklas |
366 |
</para> |
3314 |
09 May 07 |
nicklas |
367 |
</tip> |
3314 |
09 May 07 |
nicklas |
368 |
</listitem> |
3314 |
09 May 07 |
nicklas |
369 |
</varlistentry> |
3314 |
09 May 07 |
nicklas |
370 |
<varlistentry> |
3314 |
09 May 07 |
nicklas |
371 |
<term> |
5784 |
05 Oct 11 |
nicklas |
372 |
<guilabel>Units</guilabel> |
5784 |
05 Oct 11 |
nicklas |
373 |
</term> |
5784 |
05 Oct 11 |
nicklas |
374 |
<listitem> |
5784 |
05 Oct 11 |
nicklas |
375 |
<para> |
5784 |
05 Oct 11 |
nicklas |
376 |
If the export includes annotation with units, the exporter normally |
5784 |
05 Oct 11 |
nicklas |
377 |
uses the same unit that was used when annotating each item. This can be |
5784 |
05 Oct 11 |
nicklas |
378 |
different from item to item. Select this option to force all annotation |
5784 |
05 Oct 11 |
nicklas |
379 |
values to use the same unit (=the default unit for the annotation type). |
5784 |
05 Oct 11 |
nicklas |
380 |
</para> |
5784 |
05 Oct 11 |
nicklas |
381 |
</listitem> |
5784 |
05 Oct 11 |
nicklas |
382 |
</varlistentry> |
5784 |
05 Oct 11 |
nicklas |
383 |
<varlistentry> |
5784 |
05 Oct 11 |
nicklas |
384 |
<term> |
5784 |
05 Oct 11 |
nicklas |
385 |
<guilabel>Column prefix</guilabel> |
5784 |
05 Oct 11 |
nicklas |
386 |
</term> |
5784 |
05 Oct 11 |
nicklas |
387 |
<listitem> |
5784 |
05 Oct 11 |
nicklas |
388 |
<para> |
5784 |
05 Oct 11 |
nicklas |
389 |
Adds a prefix to each column header. This is useful for keeping |
5784 |
05 Oct 11 |
nicklas |
390 |
column names unique when combining multiple files outside of |
5784 |
05 Oct 11 |
nicklas |
391 |
BASE. |
5784 |
05 Oct 11 |
nicklas |
392 |
</para> |
5784 |
05 Oct 11 |
nicklas |
393 |
</listitem> |
5784 |
05 Oct 11 |
nicklas |
394 |
</varlistentry> |
5784 |
05 Oct 11 |
nicklas |
395 |
<varlistentry> |
5784 |
05 Oct 11 |
nicklas |
396 |
<term> |
3314 |
09 May 07 |
nicklas |
397 |
<guilabel>Save as</guilabel> |
3314 |
09 May 07 |
nicklas |
398 |
</term> |
3314 |
09 May 07 |
nicklas |
399 |
<listitem> |
3314 |
09 May 07 |
nicklas |
400 |
<para> |
4432 |
01 Sep 08 |
jari |
401 |
The path and file name where the exported data |
3314 |
09 May 07 |
nicklas |
402 |
should be saved. Leave the text field empty if the file is |
3314 |
09 May 07 |
nicklas |
403 |
to be downloaded immediately or enter a path within the BASE |
3314 |
09 May 07 |
nicklas |
404 |
file system to store the file on the server. Check |
3314 |
09 May 07 |
nicklas |
405 |
<guilabel>Overwrite existing file</guilabel> |
3314 |
09 May 07 |
nicklas |
406 |
if an already existing file with the same name should be |
3314 |
09 May 07 |
nicklas |
407 |
overwritten. |
3314 |
09 May 07 |
nicklas |
408 |
</para> |
3314 |
09 May 07 |
nicklas |
409 |
</listitem> |
3314 |
09 May 07 |
nicklas |
410 |
</varlistentry> |
3314 |
09 May 07 |
nicklas |
411 |
</variablelist> |
3314 |
09 May 07 |
nicklas |
412 |
|
3314 |
09 May 07 |
nicklas |
413 |
<para> |
3394 |
28 May 07 |
martin |
414 |
Click on &gbOk; |
3314 |
09 May 07 |
nicklas |
415 |
to proceed when all options have been set for the export. |
3314 |
09 May 07 |
nicklas |
416 |
</para> |
3314 |
09 May 07 |
nicklas |
417 |
</helptext> |
3314 |
09 May 07 |
nicklas |
418 |
|
4432 |
01 Sep 08 |
jari |
419 |
</sect1> |
4432 |
01 Sep 08 |
jari |
420 |
|
3675 |
16 Aug 07 |
jari |
421 |
</chapter> |