Архитектура программы

Данный раздел содержит описание программной архитектуры ColorMaster, информацию о параметрах запуска программы и особенностях сетевой работы.

Информация данного раздела предназначена для специалистов, выполняющих настройку программы ColorMaster и обладающими необходимым опытом работы с СУБД FireBird.

ColorMaster создан на основе архитектуры "клиент-сервер", в качестве сервера базы данных использовано программное обеспечение FireBird 2.1, клиентским программным обеспечением является исполняемый модуль colormaster.exe. Файл базы данных, в котором расположена вся рецептура Mobihel, а также все созданные пользователями рецепты и подборы называется cr.fdb.

Предусмотрено два варианта установки ColorMaster:

1. Однопользовательская версия

В ней допускается работа с программой только одного пользователя. Одни и те же данные не могут совместно использоваться двумя и более одновременно запущенными программами.

Однопользовательская версия использует локальный сервер базы данных, он устанавливается и настраивается при установке программы ColorMaster.

2. Многопользовательская версия

В ней допускается совместное использование одних и тех данных программами, запущенными на разных компьютерах. Пользователи могут одновременно выполнять подборы, или поиск рецептов не мешая друг другу.

Многопользовательская версия ColorMaster требует использования сервера базы данных, который необходимо отдельно установить и выполнить настройку подключения каждого рабочего места ColorMaster.

Параметры запуска программы

Параметры запуска программы ColorMaster передаются в виде ПАРАМЕТР=ЗНАЧЕНИЕ, предусмотрено три параметра:

• EMULATOR - определяет возможность работы с эмулятором весов, если параметр не задан явно, то вне зависимости от настройки весов эмулятор не будет доступен при взвешивании. Допустимыми значениями параметра являются "Y" и "N". Значение параметра "N" равносильно отсутствию параметра.
• DB_PATH - задает каталог в котором расположен файл базы данных, в значении параметра необходимо указать полное имя каталога, в котором расположен файл базы данных.
• UPDATE_SERVER - задает имя сервера обновления, с использованием которого выполняется автоматическое обноление ColorMaster, рецептур и колор боксов. Если параметр не задан, то принимается значение update.ra-soft.ru.
• DEBUG - включает регистрацию действий программы в журнальный файл сolorьaster.log. По умолчанию регистрации выключена. Допустимыми значениями параметра являются "Y" и "N".

Примеры командной строки запуска ColorMaster:

• colormaster.exe EMULATOR=Y DB_PATH=C:/DB

Запуск программы с разрешением работы эмулятора весов и использованием базы данных из каталога C:/DB

• colormaster.exe DB_PATH=C:/DB

Запуск программы без работы с эмулятором весов и использованием базы данных из каталога C:/DB

• colormaster.exe

Запуск программы без работы с эмулятором и использованием базы данных, указанной в файле colormaster.ini. Если такого файла не существует, то будет использоваться база данных, расположенная в том каталоге, где расположен файл colormaster.exe

Файл инициализации

Альтернативным способом указания адреса места расположения базы данных является файл инициализации colormaster.ini. При установке программы в каталоге установки создается указанный файл с шаблонами возможных опций:

# Host for personal server configuration it should be empty
# HOST=10.0.0.2
# Port number for network server configuration
# PORT=-1
# Path to a database file
# PATH=
# Alias to a database. If ALIAS present, then PATH ignored
# ALIAS=FBCR

Все опции этого файла отключены, так как программа игнорирует строки, начинающиеся с символа #. Для включения опции необходимо удалить этот символ, и указать значение соответствующего параметра. Файл colormaster.ini имеет текстовый формат, поэтому для его редактирования необходимо использовать обычный текстовый редактор (например Notepad). Если для редактирования применять редактор Microsoft Word, то при сохранении у файла может измениться формат, и ColorMaster не сможет считать его параметры.
Назначение параметров:

• HOST - имя хоста (или его IP-адрес), на котором установлен сервер базы данных, для однопользовательской версии опция должна быть пустой
• PORT - номер порта сервера, на котором сервер базы данных запущен для установки соединения, для однопользовательской версии должно быть -1
• PATH - каталог, в котором размещен файл базы данных (опция используется только если база данных расположена на локальном компьютере, иначе должна быть не заполнена)
• ALIAS - псевдоним базы данных, используется при многопользовательском варианте установки программы, должен содержать тот псевдоним, который присвоен базе данных FireBird

Если параметры подключения заданы двумя способами (с помощью опций командной строки и файла инициализации), то приоритетным будут параметры командной строки.

Примеры файлов инициализации:

• Соединение с сервером базы данных с псевдонимом FBCR на компьютере с IP-адресом 10.0.0.2


HOST=10.0.0.2
# PORT=-1
# PATH=
ALIAS=FBCR

• Соединение с сервером базы данных с базой данных, расположенной в каталоге C:/DB локального компьютера


# HOST=
# PORT=-1
PATH=C:/DB
# ALIAS=

Более подробная информация о параметрах настройки соединения содержится в описании СУБД FireBird.

Журнальный файл

Все действия пользователя ColorMaster может фиксировать в специальном журнальном файле. Файл располагается в том же каталоге, в котором установлен ColorMaster. Имя этого файла - colormaster.log. По умолчанию формирование журнала выключено. Для включения регистрации действий пользователя в журнальный файл необходимо добавить дополнительный параметр DEBUG="Y" в строке запуска программы.

Новые данные в журнальный файл добавляются в хронологическом порядке с указанием времени и наименования операции, а также с дополнительными данными, уточняющими эту операцию. Информация журнального файла предназначена для анализа возможных ситуаций, причин возникновения ошибок и носит служебный характер. Расшифровка файла выполняется только разработчком программы.

ColorMaster не предусматривает очистку журнального файла. Если объем файла превышает 10 мб, то создается новый файл с тем же именем, а прежний переименовывается.