Руководство пользователя «Модуль автоматического планирования стейт-машины ClearQuest» (полная версия)

Документ: Руководство пользователя «Модуль автоматического планирования стейт-машины ClearQuest » (полная версия)
Приложение: UML2ClearQuest
Наличие демо-версии: Да, доступно после регистрации на сайте для скачивания
Версия: 1.0

Оглавление

1. Перечень сокращений, условных обозначений и терминов
2. Глоссарий
3. Введение
3.1 Цель документа
3.2 Область применения
3.3 Реализация
3.4 Требования
4. Общее описание
5. Возможности
6. Описание экранных форм
6.1 Главное окно приложения
6.2 Подключение к ClearQuest
6.3 Результат экспорта в схему ClearQuest
7. Использование приложения
7.1 Примеры диаграмм
7.2 Процесс экспортирования
7.3 Экспортированная сущность в дизайнере ClearQuest
8. Нестандартные ситуации и решение проблем
СКАЧАТЬ пробную версию (download demo)   

Перечень сокращений, условных обозначений и терминов

Глоссарий

Введение

Цель документа

Ознакомить пользователей с возможностями приложения UML2ClearQuest , для эффективной работы с ним.

Документ описывает следующие области приложения UML2ClearQuest :

• функциональные возможности,

• экранные формы,

• использование продукта.

Область применения

Документ относится к продукту UML2ClearQuest и рассчитан на конечного пользователя.

Реализация

Модуль реализован в виде Win32 приложения, разработанного в среде .NET 2.0.

Требования

• Диаграмма состояний и переходов

• Схема ClearQuest ;

Общее описание

Приложение позволяет автоматизировать процесс описания состояний и переходов сущности ClearQuest , путем экспорта их из UML диаграмм. Получая на вход файл с описанием диаграммы, программа сначала пытается получить из него объекты принадлежащие типу “UML Activity” и отображает полученную диаграмму в окне приложения. Затем следует процесс проверки диаграммы на соответствие требованиям ClearQuest . Если проверка пройдена успешно, то следующим шагом является задание имени сущности и наименование ее таблицы в БД ClearQuest , а затем определение параметров экспорта и сам экспорт.

Возможности

Приложение работает с UML диаграммами Visio 2003 и StarUML. При работе с диаграммами Visio 2003, поддерживаются следующие форматы XML документов:

• XML Drawing (*.vdx)

• XML Stencil (*.vsx)

• XML Template (*.vtx)

При работе с диаграммами StarUML, поддерживается формат:

• StarUML Project File (*.uml)

На диаграммы накладывается ряд ограничений:

1. Поддерживаются только объекты секции “UML Activity”

   • Для Visio 2003 это: “Initial State”, “Final State”, “State”, “Action State” и “Control Flow”.

   • Для StarUML это: “InitialState”, “FinalState”, “ActionState”, “SubactivityState” и “Ttansition”.

2. Переход из “Initial State” и “InitialState” обязателен и может быть только один.

3. Переходов в “Final State” и “FinalState” должно быть не менее одного.

4. Все переходы, кроме переходов в “Final State” и “FinalState”, должны иметь названия.

5. Каждое состояние (“State”, “Action State”, “ActionState”, “SubactivityState”) должно иметь не менее одного входящего перехода и одного исходящего перехода.

6. Состояния не должны содержать переходов к самому себе.

7. Переходы с одинаковыми именами должны иметь одинаковое конечное состояние.

8. Все переходы должны быть привязаны к состояниям.

9. Не должно быть нескольких переходов между одними и теми же состояниями.

10. Название переходов в диаграммах Visio 2003 необходимо заносить как “Action”. Если их будет занесено несколько – программа воспримет как название только первый из них.

11. В названиях допустимы только русские или английские символы, символ “_” и цифры.

12. Максимальная длина названий не может превышать 25 символов.

13. Не должно быть состояний с одинаковыми именами.

В приложении имеется возможность, как создавать новую сущность, так и модифицировать существующую. Во втором случае не требуется вводить наименование таблицы сущности в БД ClearQuest . Наименование сущности может состоять из русских и английских символов, цифр и символа “_”, а его длина не может превышать 25 символов. Длина наименования таблицы сущности в БД ClearQuest также не может превышать 25 символов, но должна начинаться с английской буквы и состоять только из английских символов, цифр и символа “_”.

Экспорт сущности может быть произведен в файл экспорта, который можно вручную импортировать в схему ClearQuest , а можно произвести непосредственно в существующую схему ClearQuest . При выполнении экспорта в фай – нужно просто указать имя файла и его расположение. Если же экспорт осуществляется в существующую схему ClearQuest – необходимо указать название схемы. Название выбирается со списка. Он составляется автоматически, при обновлении схем, содержащихся в указанном подключении (репозитарии схем). Дополнительно в сущность еще могут быть включены действия удаления и изменения записей, с указанными именами. На имена действий налагаются те же ограничения что и на имя сущности.

Описание экранных форм

Главное окно приложения

После запуска приложения UML2ClearQuest на экране отображается главное окно программы (см. Рисунок 1), которое содержит в себе весь функционал приложения. Рассмотрим все его элементы управления с описанием выполняемых ими функций:

• Кнопка «Заполнить» – дает возможность выбрать файл с диаграммами, тип файла указывается в поле фильтра стандартного диалога открытия файла. Проводит конвертацию указанного файла и заполняет список найденных диаграмм.

• Выпадающий список «Диаграммы» – содержит список доступных диаграмм. При выборе диаграммы – она отображается в правой части окна.

• Кнопка «Проверить» – осуществляет проверку диаграммы на соответствие требованиям, изложенным в предыдущем пункте. Результат проверки отображается в поле «Результат» и, если обнаружено нарушение требований, выводится сообщение, с указанием тех требований, которые небыли выполнены.

• Поле «Результат» – отображает информацию о соответствии диаграммы всем требованиям. При соответствии требованиям – в поле, зеленым цветом, выводится надпись «Проверка пройдена», если же обнаружено какое-либо несоответствие требованиям – в поле, красным цветом, выводится строка «Проверка не пройдена».

 Рисунок 1 – Главное окно приложения

• Поле «Наименование сущности» – хранит название сущности, которая будет создана или изменена в схеме ClearQuest .

• Поле «Наименование таблицы сущности в базе» – содержит наименование таблицы которая будет создана в БД ClearQuest, для хранения информации. Это поле становиться активным лишь в том случае, когда выбрано создание новой сущности, для модификации существующей оно не нужно.

• Переключатель «Модификация существующей» – обозначает что нужно изменить уже имеющуюся сущность в схеме.

• Переключатель «Создание новой» – обозначает что будет создана новая сущность в схеме.

• Опция «Добавить действие изменения «Modify»» – при включении этой опции к списку действий сущности будет добавлено действие, с указанным именем, позволяющее изменять записи.

• Опция «Добавить действие удаления «Delete»» – при включении этой опции к списку действий сущности будет добавлено действие, с указанным именем, позволяющее удалять записи.

• Переключатель «В файл» – указывает на то, что экспорт необходимо произвести в файл экспорта.

• Переключатель «В существующую схему» – указывает на то, что сущность будет экспортирована непосредственно в существующую схему ClearQuest . При выборе такого метода – становится доступным выбор схемы, в которую будет произведен экспорт.

• Кнопка «Обновить» – запрашивает имя подключения, имя пользователя и пароль (см. Рисунок 2), для подсоединения к ClearQuest и получения списка доступных схем для указанного подключения.

• Выпадающий список «Схемы в…» – содержит список доступных схем в указанном подключении. В выбранную здесь схему будет произведен экспорт.

• Кнопка «Выполнить» – осуществляет экспорт состояний и переходов выбранной диаграммы с заданными параметрами. При выборе экспорта в файл, необходимо указать имя файла и его расположение, в который будет произведен экспорт сущности. Если же был выбран экспорт в существующую схему – программа попытается экспортировать сущность непосредственно в ClearQuest и выведет результат на экран (см. Рисунок 3).

Подключение к ClearQuest

При получении списка схем на экране отображается окно (см. Рисунок 2), запрашиваемое у пользователя имя подключения ClearQuest , а также логин и пароль для этого подключения.

Рисунок 2 – Окно подключения к ClearQuest

Результат экспорта в схему ClearQuest

При экспорте сущности в существующую схему ClearQuest на экране отображается окно с результатами экспортирования (см. Рисунок 3). При успешном экспортировании сущности в схему ClearQuest выводится сообщение «Экспорт произведен успешно», а в поле подробностей выводится сообщение консоли ClearQuest с информацией о номере новой ревизии и именем схемы. Если же произошла ошибка – выводится сообщение «Ошбка экспортирования», красным цветом, а в поле подробностей отображается сообщение консоли ClearQuest с подробной информацией о причине ошибки.

Рисунок 3 – результат экспорта в схему ClearQuest

Использование приложения

Примеры диаграмм

Рассмотрим процесс экспорта сущности в схему ClearQuest . Создадим диаграмму UML в Visio 2003 (см. Рисунок 4) или в StarUML (см. Рисунок 5).

Рисунок 4 – UML диаграмма, созданная в Visio 2003

Рисунок 5 – UML диаграмма, созданная в StarUML

Процесс экспортирования

Запустим приложение и нажмем кнопку «Заполнить», выбрав созданный ранее файл, содержащий диаграмму UML, для заполнения списка доступных диаграмм. Если диаграмм несколько – выбираем нужную из выпадающего списка. В нашем примере диаграмма только одна (см. Рисунок 6).

Рисунок 6 – UML диаграмма StarUML, открытая в приложении

Следующий этап – проверка диаграммы на соответствие требованиям ClearQuest . Для ее осуществления необходимо нажать кнопку «Проверить» (см. Рисунок 6). Если диаграмма соответствует всем требованиям – мы увидим надпись «Проверка пройдена» отображенную зеленым цветом (см. Рисунок 7).

Рисунок 7 – результат проверки диаграммы

Далее необходимо ввести наименование сущности и, если выбрано создание новой сущности, наименование таблицы сущности в БД ClearQuest (см. Рисунок 8).

Потом необходимо задать параметры экспорта. Если необходимо добавить действия удаления и изменения записей сущности, то следует указать соответствующие опции и определить названия добавляемых действий (см. Рисунок 9). Также следует указать вариант экспорта: в файл или же в существующую схему ClearQuest . Если указать экспорт в существующую схему, то также необходимо указать в какую именно схему производить экспорт. Выбор схемы осуществляется из списка (см. Рисунок 11), заполняющегося при нажатии на кнопку «Обновить» (см. Рисунок 9).

Рисунок 8 – задание наименования сущности

Рисунок 9 – определение параметров экспорта

После нажатия на кнопку «Обновить», необходимо указать в появившемся окне (см. Рисунок 10) имя подключения, в котором необходимо произвести поиск схем, а также логин и пароль для этого подключения.

Рисунок 10 – подключение с ClearQuest

После выбора нужной схемы, можно производить экспорт, нажав кнопку «Выполнить» (см. Рисунок 11). Программа выполняет экспорт используя указанный при заполнении списка схем логин и пароль. Результат экспорта отображается в новом окне (см. Рисунок 12)

Рисунок 11 – выбор схемы

Рисунок 12 – Результат экспорта

Экспортированная сущность в дизайнере ClearQuest

Рисунок 13 – Экспортированная сущность в дизайнере ClearQuest

На рисунке 13 можно видеть результат экспорта – сущность «Test» в дизайнере ClearQuest . Некоторые названия отображены не полностью из-за уменьшения размеров окна.

Нестандартные ситуации и решение проблем

В случае возникновения нестандартного поведения приложения при выполнении операций, перегрузите UML2ClearQuest и повторите операцию.

Если Вы получили сообщение о несоответствии диаграммы требованиям – внимательно прочитайте сообщение об ошибке, в нем сообщается какие именно требования не выполнены, исправьте диаграмму и повторите попытку снова.

Если при выполнении экспорта в существующую схему произошла ошибка, нужно внимательно прочитать раздел «Подробности экспортирования», там отображается ответ консоли ClearQuest с подробным описанием ошибки. Наиболее вероятные ошибки:

1. Схема находится в состоянии «Check Out» – необходимо в дизайнере сделать «Check In» или «Undo Check Out» для выбранной схемы.

2. Указанное имя сущности уже существует – необходимо указать другое имя или же удалить сущность из схемы.

3. Указано недопустимое наименование таблицы сущности в БД ClearQuest – в этом случае необходимо указать другое имя, поскольку указанное ранее является зарезервированным.

СКАЧАТЬ пробную версию (download demo)

Для скачивания демо-версии UML2ClearQuest необходимо зарегистрироваться на нашем сайте и перейти в раздел cкачивание (download)

26.07.2008

Добавить комментарий (анонимные комментарии не публикуются!!!)

ФИО:
E-mail:
Тема:
Комментарий:
Оценка:
Код подтверждения:

Новости и пресс-релизы СМ-Консалт

Архив "Новости и пресс-релизы СМ-Консалт"