Project

General

Profile

Working-with-reqdb » History » Version 41

Илья Рудаков, 01/15/2010 04:53 PM

1 2 Илья Рудаков
h1. Working with reqdb console interface
2
3
h2. Описание
4
5 6 Илья Рудаков
Дистрибутив ReqDB выглядит следующим образом:
6 2 Илья Рудаков
7
<pre>
8
/..
9
/bin
10
/libs
11
/src
12
/templates
13 3 Илья Рудаков
 reqdb-someversion.jar
14 2 Илья Рудаков
</pre>
15 1 Илья Рудаков
16 3 Илья Рудаков
В папке /bin находится три файла для работы с reqdb в консольном режиме: reqdb, reqdb.64 и reqdb.exe. Первые два позволяют вам работать в Linux системе, последний - в Windows.
17
Если вы работаете в Linux, reqdb и reqdb.64 нужно сделать executable. Достаточно набрать следующую команду в консоли:
18
<pre>$ chmod +x reqdb</pre>
19 4 Илья Рудаков
или
20 3 Илья Рудаков
<pre>$ chmod +x reqdb.64</pre>
21 7 Илья Рудаков
reqdb.64 используется если у вас Linux x64.
22 8 Илья Рудаков
23
h2. Работа с консольным интерфейсом
24
25
Если вы запустите один из вышеописанных файлов без каких-либо параметров, то на консоль будет выведена следующая информация:
26
<pre>Usage: reqdb <help|import|convert|init|report> [params]</pre>
27
28
Вы видите, что в интерфейсе используется 5 параметров.
29 24 Илья Рудаков
30 35 Илья Рудаков
> *+help+* параметр выводит вспомогательную информацию о других параметрах. Например, вызов <pre>$reqdb help import</pre> выведет на экран следующую информацию <pre>Usage: reqdb import <input file> <path to catalogue> <root id>
31 10 Илья Рудаков
OR
32
reqdb import <input file> <path to catalogue> <root id> <branch path>
33
</pre>
34 11 Илья Рудаков
35 24 Илья Рудаков
36 36 Илья Рудаков
> *+import+* позволяет импортировать существующий документ с разметкой требований в каталог требований. Для данного параметра предусмотрено следующие использование: <pre>Usage: reqdb import <input file> <path to catalogue> <root id>
37 12 Илья Рудаков
OR
38
reqdb import <input file> <path to catalogue> <root id> <branch path>
39 23 Илья Рудаков
</pre> *_<input file>_* - путь к документу, который должен быть импортирован в каталог требований; *_<path to catalogue>_* - путь к каталогу требований; *_<root id>_* - идентификатор корневого требования; *_<branch path>_* - путь branch''а импортируемых требовании.
40 24 Илья Рудаков
41
42 38 Илья Рудаков
> *+convert+* позволяет конвертировать документы со старой разметкой требований в документ с новой разметкой требований. Для данного параметра предусмотрено следующие использование: <pre>Usage: reqdb convert <input file> <output file> <opt_encoding>
43 24 Илья Рудаков
OR
44 38 Илья Рудаков
reqdb convert <input dir> <output dir> <opt_encoding>
45
</pre> *_<input file>_* - путь к html файлу со старой разметкой требований; *_<output file>_* - путь к результирующему файлу; *_<input dir>_* - путь к директории с документами; *_<output dir>_* - путь к директории куда будут сохранены файлы; *_<opt_encoding>_* - кодировка( если параметр не указан, то используется стандартная кодировка UTF-8 )
46 26 Илья Рудаков
47
48 36 Илья Рудаков
> *+init+* позволяет создать новый пустой каталог требований. Для данного параметра предусмотрено следующие использование: <pre>Usage: reqdb init <path to new catalogue></pre> *_<path to new catalogue>_* - путь где должен быть создан новый каталог требований.
49 28 Илья Рудаков
50
51 37 Илья Рудаков
> *+report+* позволяет генерировать отчет. Для данного параметра предусмотрено следующие использование: <pre>Usage: reqdb report <path to template> <path to catalogue> <root id> <save location></pre> *_<path to template>_* - путь к template.xml( в нем описывается связка - имя файла с freemarker шаблоном -> имя результирующего файла ); *_<path to catalogue>_* - путь к каталогу требований; *_<root id>_* - идентификатор корневого требования; *_<save location>_* - путь к папке куда должен быть сохранен файл с отчетом;
52 39 Илья Рудаков
53 41 Илья Рудаков
> *+complex-import+* позволяет одновременно импортировать html документ со старой разметкой требований и требования из него в базу данных. Для данного параметра предусмотрено следующие использование: <pre>Usage: reqdb complex-import <input dir> <output dir> <catalogue path> <root id> <opt_encoding> <opt_branch></pre> *_<input dir>_* - путь к директории, где хранятся html документы; *_<output dir>_* - путь к директории, куда будут импортированы документы; *_<catalogue path>_* - путь к каталогу требований; *_<root id>_* - идентификатор корневого требования; *_<opt_encoding>_* - кодировка( optional ); *_<opt_branch>_* - путь branch''а импортируемых требовании