Project

General

Profile

Working-with-reqdb » History » Version 62

Андрей Третьяков, 01/20/2012 06:03 PM
grammar fixes

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 42 Илья Рудаков
В папке /bin находится три файла для работы с reqdb в консольном режиме: reqdb, reqdb.64 и reqdb.exe. Первые два позволяют вам работать в Linux системе, последний - в Windows. Так же в этой папке лежит logger.properties. В этом файле описаны простые настройки logging системы.
17 3 Илья Рудаков
Если вы работаете в Linux, reqdb и reqdb.64 нужно сделать executable. Достаточно набрать следующую команду в консоли:
18
<pre>$ chmod +x reqdb</pre>
19 4 Илья Рудаков
или
20 3 Илья Рудаков
<pre>$ chmod +x reqdb.64</pre>
21 62 Андрей Третьяков
reqdb.64 используется, если у вас Linux x64.
22 42 Илья Рудаков
23 48 Илья Рудаков
h3. Настройка логов
24 47 Илья Рудаков
25 42 Илья Рудаков
Настройки для логов хранятся в файле bin/logger.properties. По умолчанию он выглядит следующим образом: 
26
<pre>appender.type=console
27
log.path=/tmp/reqdb-logs/reqdb.log</pre>
28 8 Илья Рудаков
29 55 Илья Рудаков
*_appender.type_* - тип вывода информации логов. Всего поддерживается два типа: *console* и *file*. По умолчанию стоит значение *console*. Все логи в этом режиме будут выводиться на консоль монитора. 
30 58 Илья Рудаков
Если же вы хотите, чтобы логи писались в файл, установите *appender.type=file*. При этом не забудьте указать путь к файлу *log.path*, в который будут сохраняться логи. Совсем не обязательно, чтобы файл существовал. Если такового не существует, он будет создан автоматически. При этом, конечный файл будет выглядеть следующим образом: /tmp/reqdb-logs/reqdb_DD-MM-YYYY.log. При изменении даты в календаре будет создаваться новый log-файл в соответствии с этим шаблоном.
31
<pre>Замечание! Если вы работаете на Windows платформе, log.path нужно указывать с использованием двойных slash символов "\\", 
32 60 Илья Рудаков
как показано в этом примере: log.path=C:\\reqdb-logs\\reqdb.log</pre>
33 49 Илья Рудаков
34 8 Илья Рудаков
h2. Работа с консольным интерфейсом
35
36
Если вы запустите один из вышеописанных файлов без каких-либо параметров, то на консоль будет выведена следующая информация:
37
<pre>Usage: reqdb <help|import|convert|init|report> [params]</pre>
38
39
Вы видите, что в интерфейсе используется 5 параметров.
40 24 Илья Рудаков
41 35 Илья Рудаков
> *+help+* параметр выводит вспомогательную информацию о других параметрах. Например, вызов <pre>$reqdb help import</pre> выведет на экран следующую информацию <pre>Usage: reqdb import <input file> <path to catalogue> <root id>
42 10 Илья Рудаков
OR
43
reqdb import <input file> <path to catalogue> <root id> <branch path>
44
</pre>
45 11 Илья Рудаков
46 24 Илья Рудаков
47 36 Илья Рудаков
> *+import+* позволяет импортировать существующий документ с разметкой требований в каталог требований. Для данного параметра предусмотрено следующие использование: <pre>Usage: reqdb import <input file> <path to catalogue> <root id>
48 12 Илья Рудаков
OR
49
reqdb import <input file> <path to catalogue> <root id> <branch path>
50 23 Илья Рудаков
</pre> *_<input file>_* - путь к документу, который должен быть импортирован в каталог требований; *_<path to catalogue>_* - путь к каталогу требований; *_<root id>_* - идентификатор корневого требования; *_<branch path>_* - путь branch''а импортируемых требовании.
51 24 Илья Рудаков
52
53 38 Илья Рудаков
> *+convert+* позволяет конвертировать документы со старой разметкой требований в документ с новой разметкой требований. Для данного параметра предусмотрено следующие использование: <pre>Usage: reqdb convert <input file> <output file> <opt_encoding>
54 24 Илья Рудаков
OR
55 38 Илья Рудаков
reqdb convert <input dir> <output dir> <opt_encoding>
56 62 Андрей Третьяков
</pre> *_<input file>_* - путь к html файлу со старой разметкой требований; *_<output file>_* - путь к результирующему файлу; *_<input dir>_* - путь к директории с документами; *_<output dir>_* - путь к директории куда будут сохранены файлы; *_<opt_encoding>_* - кодировка (если параметр не указан, то используется стандартная кодировка UTF-8).
57 26 Илья Рудаков
58
59 62 Андрей Третьяков
> *+init+* позволяет создать новый пустой каталог требований. Для данного параметра предусмотрено следующие использование: <pre>Usage: reqdb init <path to new catalogue></pre> *_<path to new catalogue>_* - путь, где должен быть создан новый каталог требований.
60 28 Илья Рудаков
61
62 62 Андрей Третьяков
> *+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>_* - путь к папке, куда должен быть сохранен файл с отчетом.
63 39 Илья Рудаков
64 62 Андрей Третьяков
> *+complex-import+* позволяет одновременно импортировать html документ со старой разметкой требований и требования из него в базу данных. Для данного параметра предусмотрено следующие использование: <pre>Usage: reqdb complex-import <input dir> <catalogue path> <root id> <opt_branch></pre> *_<input dir>_* - путь к директории, где хранятся html документы; *_<catalogue path>_* - путь к каталогу требований; *_<root id>_* - идентификатор корневого требования; *_<opt_branch>_* - путь branch''а импортируемых требовании.