Requality

h1. Working with reqdb console interface

h2. Описание

Дистрибутив ReqDB выглядит следующим образом:

<pre>

/..

/bin

/libs

/src

/templates

 reqdb-someversion.jar

</pre>

В папке /bin находится три файла для работы с reqdb в консольном режиме: reqdb, reqdb.64 и reqdb.exe. Первые два позволяют вам работать в Linux системе, последний - в Windows. Так же в этой папке лежит logger.properties. В этом файле описаны простые настройки logging системы.

Если вы работаете в Linux, reqdb и reqdb.64 нужно сделать executable. Достаточно набрать следующую команду в консоли:

<pre>$ chmod +x reqdb</pre>

или

<pre>$ chmod +x reqdb.64</pre>

reqdb.64 используется если у вас Linux x64.

h3. Настройка логов

Настройки для логов хранятся в файле bin/logger.properties. По умолчанию он выглядит следующим образом: 

<pre>appender.type=console

log.path=/tmp/reqdb-logs/reqdb.log</pre>

*_appender.type_* - тип вывода информации логов. Всего поддерживается два типа: *console* и *file*. По умолчанию стоит значение *console*. Все логи в этом режиме будут выводиться на консоль монитора. 

Если же вы хотите, чтобы логи писались в файл, установите *appender.type=file*. При этом не забудьте указать путь к файлу *log.path*, в который будут сохраняться логи. Совсем не обязательно, чтобы файл существовал. Если такового не существует, он будет создан автоматически. При этом, конечный файл будет выглядеть следующим образом: /tmp/reqdb-logs/reqdb_DD-MM-YYYY.log. При изменении даты в календаре будет создаваться новый log-файл в соответствии с этим шаблоном.

<pre>Замечание! Если вы работаете на Windows платформе, log.path нужно указывать с использованием двойных slash символов "\\", 

как показано в этом примере: *log.path=C:\\reqdb-logs\\reqdb.log*</pre>

h2. Работа с консольным интерфейсом

Если вы запустите один из вышеописанных файлов без каких-либо параметров, то на консоль будет выведена следующая информация:

<pre>Usage: reqdb <help|import|convert|init|report> [params]</pre>

Вы видите, что в интерфейсе используется 5 параметров.

> *+help+* параметр выводит вспомогательную информацию о других параметрах. Например, вызов <pre>$reqdb help import</pre> выведет на экран следующую информацию <pre>Usage: reqdb import <input file> <path to catalogue> <root id>

OR

reqdb import <input file> <path to catalogue> <root id> <branch path>

</pre>

> *+import+* позволяет импортировать существующий документ с разметкой требований в каталог требований. Для данного параметра предусмотрено следующие использование: <pre>Usage: reqdb import <input file> <path to catalogue> <root id>

OR

reqdb import <input file> <path to catalogue> <root id> <branch path>

</pre> *_<input file>_* - путь к документу, который должен быть импортирован в каталог требований; *_<path to catalogue>_* - путь к каталогу требований; *_<root id>_* - идентификатор корневого требования; *_<branch path>_* - путь branch''а импортируемых требовании.

> *+convert+* позволяет конвертировать документы со старой разметкой требований в документ с новой разметкой требований. Для данного параметра предусмотрено следующие использование: <pre>Usage: reqdb convert <input file> <output file> <opt_encoding>

OR

reqdb convert <input dir> <output dir> <opt_encoding>

</pre> *_<input file>_* - путь к html файлу со старой разметкой требований; *_<output file>_* - путь к результирующему файлу; *_<input dir>_* - путь к директории с документами; *_<output dir>_* - путь к директории куда будут сохранены файлы; *_<opt_encoding>_* - кодировка( если параметр не указан, то используется стандартная кодировка UTF-8 )

> *+init+* позволяет создать новый пустой каталог требований. Для данного параметра предусмотрено следующие использование: <pre>Usage: reqdb init <path to new catalogue></pre> *_<path to new catalogue>_* - путь где должен быть создан новый каталог требований.

> *+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>_* - путь к папке куда должен быть сохранен файл с отчетом;

> *+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''а импортируемых требовании