Установка программы
Для установки программы разархивируйте oapi.zip в любую подходящую директорию.
Архив содержит следующие файлы:
- oapi.jar - классы программы
- oapi.bat - файл для запуска программы
- OAPI.css - таблица стилей для html-файла с описанием объекта(определяет формат отображения описания объекта в браузере)
- OAPI_CONTENT.css - таблица стилей для html-файла с оглавлением (определяет формат отображения оглавления в браузере)
- oapi.oh - шаблон для html-файла, используемого для открытия документации в браузере
- cont.oh - шаблон для html-файла, содержащего оглавление
- desc.oh - шаблон для html-файла, содержащего описание объекта БД
- OAPI_Blanc.htm - html-файл, отображающийся в правой части после открытия документации.
- UserGuid.htm - руководство пользователя
Запуск программы
Для работы программы не требуется установка Oracle Client.
Для работы программы необходима Java версии 1.4.1.0 или выше.
Для запуска программы используйте oapi.bat.
Если на Вашем компьютере установлено несколько версий Java, то, возможно, потребуется указать путь к версии, которую Вы хотите использовать (например, в случае, если по умолчанию запускается версия меньшая, чем требуется для работы программы). В этом случае необходимо скорректировать файл oapi.bat - добавить путь к файлу java.exe нужной версии.
Пример текста измененного файла:
C:\j2sdk1.4.1_01\bin\java -jar oapi.jar
Работа с программой
При запуске необходимо указать параметры базы данных, к которой Вы пытаетесь присоединиться:
- Protocol - тип сетевого протокола (обычно tcp)
- Host - сетевой адрес машины, на которой установлена база данных
- Port - номер порта, который используется для подсоединения к базе данных
- Database name - имя базы данных
- User Name - имя пользователя базы данных
- Password - пароль пользователя базы данных
(Если на Вашем компьютере установлено клиентское ПО Oracle, то Вы можете посмотреть параметры в файле ORA_HOME\network\ADMIN\tnsnames.ora, так же Protocol, Host и Port можно узнать выполнив команду tnsping имя_базы_данных )
После подключения к базе данных откроется основное окно
программы:
В нем необходимо выбрать имя схемы базы данных, объекты которой будут описываться. Можно выбрать несколько схем. Для этого необходимо удерживать кнопку Ctrl и щелкать мышкой по имени соответствующей схемы.
Чтобы получить описание одного из типов объектов БД (таблицы, процедуры, функции, пакеты, типы) необходимо поставить галочку напротив его названия.
Кроме того, можно ввести фильтр для имен описываемых объектов в поле, расположенном под наименованием типа объекта. Синтаксис фильтра такой же, как и при использовании LIKE в SQL выражениях.
В показанном примере будет сформирована документация с описанием таблиц, имена которых начинаются на ‘HR<один любой символ><любое количество любых символов>’ и всех функций из схем с именами SCOTT и SYS
Необходимо указать директорию, где будут находить файлы документации, и имя html-файла, который необходимо будет запускать для просмотра документации.
Для запуска процедуры формирования документации необходимо нажать кнопку «Process»
В нижней части окна отображается информация о работе программы (включая сообщения об ошибках).
Установка языка интерфейса
Можно установить язык интерфейса пользователя (в настоящее время поддерживаются русский и английский языки).
Для смены языка зайдите в меню "Язык интерфейса" (Interface language) и выберите нужный. Выбранный язык будет использоваться для подписи элементов интерфейса (кроме окна, в котором задаются параметры соединения с базой данных) и текста сообщений.
Сохранение отладочной информации
Данная версия является тестовой и в ней предусмотрена возможность ведения лога выполняемых программой действий. По умолчанию ведение лога отключено. Чтобы включить ведение лога зайдите в меню "Отладка" ("Debugging") и выберите уровень отладки. Чем выше уровень, тем больше детализация действий программы. При уровне 0 сохраняются только сообщения об ошибках. При уровне 1 к сообщениям об ошибках добавляется информация о начале и окончании выполнения методов, и т.д.
По умолчанию отладочная информация сохраняется в файле OAPI.log. Вы можете изменить файл для отладки. Для этого выберете пункт меню "Отладка-Установить файл для вывода отладочных сообщений" ("Debugging-Set log file") и в появившемся диалоге выберите (при необходимости создайте директорию и файл), в который будет выводиться отладочная информация.
Параметры для выбора описываемых объектов, пути к файлам создаваемой документации и лог-файлу, а также настройки языка интерфейса и уровня отладки сохраняются при закрытии программы и автоматически восстанавливаются при следующем ее запуске.
Просмотр документации
Для просмотра документации необходимо отрыть в браузере
файл, который был указан в поле Directory for documentation.
В левой части отображается список объектов, в правой части - описание выбранного объекта.
Вы можете настроить формат отображения содержания и описания объекта БД изменив используемые в них таблицы стилей (OAPI_CONTENT.css и OAPI.css)
Тэги, используемые для отображения элементов текста:
- FONT.PACKAGE_NAME - имя пакета
- FONT.TABLE_NAME - имя таблицы
- FONT.INDEX - имя индекса
- FONT.PROC_NAME - имя процедуры и функции
- FONT.TYPE - имя типа данных
- FONT.P_NAME - имя параметра
- FONT.P_TYPE - имя типа параметра
- FONT.RETURN - слово RETURN
- FONT.P_DEFAULT - слово DEFAUL
- FONT.P_COMMENT - комментарий
- FONT.P_IN_OUT - слова IN и OUT
- FONT.P_NOCOPY - слово NOCOPY
Так же можно скорректировать шаблоны html-файлов:
- oapi.oh - шаблон для html-файла, используемого для открытия документации в браузере
- cont.oh - шаблон для html-файла, содержащего оглавление
- desc.oh- шаблон для html-файла, содержащего описание объекта БД
- OAPI_Blanc.htm - html-файл, отображающийся в правой части после открытия документации.