Alpha.Community

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

Настройка в Alpha.DevStudio

Настройка обмена данными между модулем SQL Клиент и источником выполняется в среде разработки Alpha.DevStudio.

Чтобы настроить обмен данными с источником:

  • добавьте в проект и настройте источник, с которым будет выполняться обмен данными;
  • в Alpha.Server добавьте и настройте модуль SQL Клиент;
  • настройте обмен данными между источником и модулем SQL Клиент;
  • примените конфигурацию Alpha.Server.

Порядок создания проекта и добавление Alpha.Server в проект описаны в документации на Alpha.DevStudio (раздел Знакомство с Alpha.DevStudio руководства пользователя).

Далее приведено описание настройки обмена данными Alpha.Server с источником данных с помощью запросов языка SQL.

Настройка источника данных

  1. Перейдите в Alpha.Domain → Узел Alpha.Domain, и добавьте Исполняющий компонент.

  2. Перейдите в Исполняющий компонент и добавьте элементы Приложение и База данных SQL.

  3. Перейдите в Приложение и добавьте элемент Карта адресов SQL.

    В дальнейшем в Приложение будут добавлены экземпляры логических типов.

  4. На элементе Карта адресов SQL:

    1. Нажмите кнопку .
    2. Укажите место хранения карты адресов на диске.
    3. Задайте имя карты адресов.
    4. Нажмите кнопку Открыть.

    Карта адресов будет создана. Если требуется открыть существующую карту адресов, то выберите файл карты адресов на диске и нажмите кнопку Открыть.

  5. Вернитесь в Исполняющий компонент и настройте Базу данных SQL: в свойстве Карта адресов укажите ранее добавленную Карту адресов SQL.

Свойства Базы данных SQL:

Свойство Описание

Имя

Название базы данных SQL в проекте.

Карта адресов Расположение карты адресов, которую будет использовать база данных SQL.

Настройка нескольких источников данных

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

Настройка SQL Клиент

  1. Перейдите в Alpha.Domain → Узел Alpha.Domain → Alpha.Server и добавьте Приложение.

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

  2. В Alpha.Server из папки Коммуникационные модули добавьте SQL Клиент.

    Для свойств SQL Клиент можно оставить значения по умолчанию.

    Свойство Описание

    Общие

    Имя

    Идентификатор модуля в конфигурации Alpha.Server, значение сервисного сигнала Id.

    Параметры модуля
    Активность

    Активность модуля при запуске/перезапуске Alpha.Server:

    • Да – модуль запущен;
    • Нет – модуль остановлен.

    Управляется служебным сигналом Active.Set.

    Отображаемое имя

    Название модуля, которое отображается в тегах служебных сигналов.

    Неявное приведение ODBC типов большей размерности к типам меньшей размерности

    Записывать значения бóльшей размерности в сигналы/столбцы меньшей размерности.

    Если типы данных столбцов таблицы в БД не совпадают с размерностью типов сигналов Alpha.Server, то установите значение Да.

    Значение по умолчанию - Нет.

    Значение учитывается только если в Параметрах взаимодействия с базой данных параметру Поставщик данных установлено значение ODBC.

    Параметры журналирования

    Вести журнал работы модуля

    Ведение записи сообщений о работе модуля в журнал работы:

    • Да – вести журнал работы;
    • Нет – журнал работы не ведётся.

    Управляется служебным сигналом FrameLogEnable.Set.

    Размер журнала работы модуля, МБ

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

    Количество дополнительных журналов работы

    Количество файлов заполненных журналов работы модуля:

    • минимальное количество – 1;
    • максимальное количество – 255.

    Уровень трассировки в журнал приложений

    Типы сообщений, которые выводятся в журнал приложений:

    • Предупреждения и аварийные сообщения – логические ошибки и ошибки работы модуля. Предупреждения содержат некритичные ошибки. Аварийные сообщения информируют об ошибках, которые влияют на работоспособность сервера;
    • Информационные сообщения – предупреждения и аварийные сообщения, а также основная информация о работе модуля;
    • Отладочные сообщения – предупреждения и аварийные сообщения, основная и детальная информация о работе модуля.

    Управляется служебным сигналом SystemLogTraceLevel.Set.

Настройка связи с БД

  1. На элементе SQL Клиент нажмите кнопку и укажите ранее настроенную Базу данных SQL.

  2. Выделите добавленную БД и настройте параметры взаимодействия SQL Клиент с Базой данных SQL.

    В примере для настройки обмена данными:

    • Поставщик данных - ODBC;
    • строка подключения разделена на две части:
      • Открытая часть строки подключения имеет вид:

        Driver={PostgreSQL Unicode(x64)};Server=127.0.0.1;Port=5432;Database=postgres;
        
      • Секретная часть строки подключения имеет вид:

        UID=postgres;PWD=qwerty@123;
        
    Свойство Описание

    База данных SQL

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

    Интерфейс доступа к данным.

    Значение по умолчанию - OLE DB.

    Открытая часть строки подключения

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

    Период попытки подключения к источнику, мс

    Свойство будет доступно для использования в последующих релизах Alpha.Server.

    Секретная часть строки подключения

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

Настройка обмена данными

Для настройки обмена данными между модулем SQL Клиент и источником:

Настройка списка SQL-запросов

Чтобы настроить список SQL-запросов, которые модуль SQL Клиент будет отправлять источникам:

  1. Перейдите в Alpha.Domain → Узел Alpha.Domain → Исполняющий компонент → Приложение.
  2. По умолчанию Карта адресов SQL содержит одну группу SQL-запросов. Если требуется настроить несколько групп, то добавьте нужное количество групп SQL-запросов кнопкой .

  3. На элементе Карта адресов SQL нажмите кнопку для перехода к настройкам группы SQL-запросов.

  4. В группу SQL-запросов для каждого запроса, который требуется выполнять, добавьте элемент SQL запрос.

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

    Параметр Описание
    Имя Имя SQL-запроса.
    Период исполнения запроса, мс

    Период в миллисекундах, через который модуль будет отправлять SQL-запрос источнику.

    Значение по умолчанию - 10000.

    Чтобы модуль отправлял запрос источнику по команде, укажите значение 0.

    Текст запроса

    Текст SQL-запроса, который модуль SQL Клиент будет отправлять источнику.

    Значения остальных параметров можно оставить по умолчанию.

    Параметр Описание
    Возможность результата запроса быть пустым

    При получении пустого результата запроса:

    • True - качество сигналов не изменяется;
    • False - сигналам будет установлено плохое качество.

    Значение по умолчанию - False.

    Имя ключевого поля Имя столбца таблицы, по которому будет выполняться дополнительная фильтрация данных. Если дополнительная фильтрация не требуется, то оставьте поле пустым.
    Качество при неполном значении

    Если в результате запроса значение, качество или метка времени имеют пустое значение (NULL), то сигналу устанавливать заданное качество.

    Значение по умолчанию - 64 (Uncertain) (данные не получены).

    Часовой пояс

    Часовой пояс (UTC), в котором хранятся метки времени в источнике.

    К указанному часовому поясу будут приведены метки времени значений:

    • полученных от источника запросами SELECT;
    • отправляемых в источник запросами UPDATE, INSERT.
  6. Если требуется выполнять некоторые запросы при инициализации (перед первым запросом), то в настройках группы SQL-запросов укажите список таких запросов в параметре Запросы инициализации. Имена запросов можно задавать через запятую. Если запросы инициализации не требуются, то оставьте параметр пустым.

В примере для настройки обмена данными требуется настроить 5 запросов со следующими параметрами:

Имя запроса Текст запроса Период исполнения запроса, мс
Id SELECT param_name,value,quality,timestamp FROM tank_db WHERE id=? 1000
String SELECT param_name,value,quality FROM tank_db WHERE param_name LIKE ? 5000
NewName UPDATE tank_db SET param_name=? WHERE id=? 0
NewData INSERT INTO tank_db(id,param_name,value,quality,timestamp) VALUES (?,?,?,?,?) 0
Delete DELETE FROM tank_db WHERE id=? AND param_name=? 0

Для всех запросов:

  • значение параметра Имя ключевого поля оставьте пустым;
  • в параметре Часовой пояс укажите часовой пояс, в котором работает Alpha.Server;
  • значения остальных параметром оставьте по умолчанию.

Значения по умолчанию

Для каждого запроса можно указать значения по умолчанию, которые следует устанавливать столбцам, если результат запроса имеет пустое значение (NULL). Чтобы добавить в запрос значения по умолчанию:

  1. Добавьте нужное количество значений кнопкой .

  2. Укажите Имя столбца и его Значение по умолчанию.

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

Настройка логических типов

  1. Добавьте в проект два элемента Пространство имен для логических типов источника и Alpha.Server. Каждому элементу задайте Имя, например, DB_Types и Server_Types.

  2. В каждое Пространство имен добавьте Аспект.

    Задайте Имя каждому добавленному аспекту:

    • в пространстве имён DB_Types - аспект DB;
    • в пространстве имён Server_Types - аспект Server.

Логические типы источника

Чтобы настроить логический тип источника:

  1. Перейдите в Пространство имен DB_Types и добавьте Логический тип. В свойствах логического типа укажите:

    Параметр Описание
    Имя Имя логического типа.
    Аспект Добавленный ранее аспект источника - DB.

  2. Перейдите в Логический тип и опишите его структуру: добавьте сигналы требуемых типов, укажите им Имя и Направление.

Для получения и изменения значений таблицы из примера для настройки обмена данными добавьте следующие логические типы с сигналами:

Сигнал Тип Направление Описание
Логический тип Read_ID (для запроса 1)
Id Int8 вход Идентификатор параметра, данные которого требуется получить из БД (столбец id).
Name

String

выход Название параметра (столбец param_name).
Value

Uint8

выход Значение параметра (столбец value).
Логический тип Read_Name (для запроса 2)
String String вход Строка в названии параметра, данные которого требуется получить из БД (столбец param_name).
Name

String

выход Название параметра (столбец param_name).
Value Uint8 выход Значение параметра (столбец value).
Логический тип Update (для запроса 3)
Id Int8 вход Идентификатор параметра, название которого требуется обновить (столбец id).
Name String вход Обновленное название параметра, которое требуется записать в БД (столбец param_name).
Логический тип Insert (для запроса 4)
Id Int8 вход Идентификатор нового параметра, который требуется добавить в БД (столбец id).
Name String вход Название нового параметра, который требуется добавить в БД (столбец param_name).
Value Uint8 вход Значение нового параметра, который требуется добавить в БД (столбец value).
Quality Uint8 вход Качество нового параметра, который требуется добавить в БД (столбец quality).
Time String вход Метка времени нового параметра, который требуется добавить в БД (столбец timestamp).
Логический тип Delete (для запроса 5)
Id Int8 вход Идентификатор параметра, который требуется удалить из БД (столбец id).
Name String вход Название параметра, который требуется удалить из БД (столбец param_name).

Добавленные логические типы источника:

Логические типы Alpha.Server

Чтобы настроить логический тип Alpha.Server:

  1. Перейдите в Пространство имен Server_Types и добавьте Логический тип. В свойствах логического типа укажите:

    Параметр Описание
    Имя Имя логического типа.
    Аспект Добавленный ранее аспект - Server.
    Представляемый тип Описанный ранее логический тип источника.

    Добавленный Логический тип будет представлять описанный ранее логический тип источника, только со стороны Alpha.Server.

  2. Перейдите в Логический тип и добавьте Ссылку. В свойствах добавленной ссылки укажите:

    Параметр Описание
    Имя Имя ссылки.
    Тип Описанный ранее логический тип источника.

    После указания Типа в элементе Ссылка отобразится структура соответствующего логического типа источника. Добавленная ссылка будет связывать логический тип Alpha.Server с логическим типом источника.

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

Логические типы Alpha.Server из примера для настройки обмена данными:

Добавление типов в приложения источника и Alpha.Server

  1. Перейдите в приложение источника. Ранее в него уже была добавлена Карта адресов SQL. Теперь добавьте в приложение экземпляры логических типов источника.

  2. Перейдите в приложение Alpha.Server:
    1. Вызовите контекстное меню и выполните команду Создать здесь представления объектов....

    2. Выберите объекты из приложения источника, для которых требуется создать представления, и нажмите кнопку Далее.

    3. Проверьте список выбранных объектов и нажмите кнопку Далее.

  3. В качестве аспекта новых представлений укажите аспект Server и нажмите кнопку Готово.

    Представления выбранных объектов будут созданы в приложении Alpha.Server.

Получение и запись значений параметров БД

Чтобы получать от источника и отправлять в источник значения параметров БД, перейдите в Карту адресов SQL и настройте параметры адреса для каждого сигнала:

Поле Значение
Привязка непосредственно.
Имя группы Имя группы, к которой относится запрос.
Имя запроса Имя запроса, который будет отправлен в источник для получения или записи значения данного сигнала в БД.
Тип

Тип привязки сигнала:

  • QRead - в значение сигнала записывать результат выполнения запроса;
  • QParam - значение сигнала подставлять в запрос с параметрами для динамического формирования SQL-запроса.

Для сигналов с типом привязки QRead настройте параметры адреса:

Поле Значение
Value Имя столбца таблицы, значение которого будет записано в значение сигнала (свойство сигнала 2 (Value)).
Quality Имя столбца таблицы, значение которого будет записано в качество сигнала (свойство сигнала 3 (Quality)). Если не указано, то сигналу будет установлено качество GOOD.
Timestamp

Имя столбца таблицы, значение которого будет записано в метку времени сигнала (свойство сигнала 4 (Timestamp)). Если не указано, то сигналу будет установлено текущее время Alpha.Server.

KeyFieldValue Значение столбца таблицы, указанного в параметре запроса Имя ключевого поля. Если указано, то к результату запроса будет применён дополнительный фильтр: результат запроса будет содержать только те строки, где ключевое поле принимает указанное значение.

Для сигналов с типом привязки QParam настройте параметры адреса:

Поле Значение
ParamID

Порядковый номер параметра запроса, обозначенного символом ?, вместо которого будет подставлено значение сигнала для динамического формирования SQL-запроса.

ParamValuePropID Номер свойства сигнала, значение которого будет подставлено в текст запроса вместо параметра ?. Если не указано, то будет подставлено свойство 2 (Value).

Ниже приведены настройки SQL-запросов и соответствующие настройки адресов сигналов для получения и записи значений параметров БД из примера для настройки обмена данными:

  1. Запрос Id и адреса сигналов логического типа Read_ID:

    1. Значение сигнала Read_ID.Id будет подставлено в текст запроса Id в параметр запроса ? с порядковым номером 1.
    2. В результате выполнения запроса Id в свойства сигналов будут записаны значения столбцов таблицы tank_db, соответствующие параметру с идентификатором, равным значению сигнала Read_ID.Id:
      • В значение сигнала Read_ID.Name будет записано значение столбца param_name.
      • Для сигнала Read_ID.Value:
        • в значение будет записано значение столбца value;
        • качество будет установлено из столбца quality;
        • метка времени будет установлена из столбца timestamp.
  2. Запрос String и адреса сигналов логического типа Read_Name:

    1. Значение сигнала Read_Name.String будет подставлено в текст запроса String в параметр запроса ? с порядковым номером 1.

      Для выполнения запроса с оператором LIKE значение сигнала, которое будет подставлено в параметр запроса ?, должно быть задано в формате %строка%. Пример:

      %Уровень%
    2. В результате выполнения запроса String в свойства сигналов будут записаны значения столбцов таблицы tank_db, соответствующие параметру со строкой из значения сигнала Read_Name.String:
      • В значение сигнала Read_Name.Name будет записано значение столбца param_name.
      • Для сигнала Read_Name.Value:
        • в значение будет записано значение столбца value;
        • качество будет установлено из столбца quality.
  3. Запрос NewName и адреса сигналов логического типа Update:

    1. Значение сигнала Update.Id будет подставлено в текст запроса NewName в параметр запроса ? с порядковым номером 1.
    2. Значение сигнала Update.Name будет подставлено в текст запроса NewName в параметр запроса ? с порядковым номером 2.
    3. В результате выполнения запроса NewName в таблицу tank_db в строку с идентификатором, равным значению сигнала Update.Id, в столбец param_name будет записано значение сигнала Update.Name.
  4. Запрос NewData и адреса сигналов логического типа Insert:

    1. Значения сигналов будут подставлены в текст запроса NewData в параметры запроса ? с порядковыми номерами:
      • 1 - значение сигнала Insert.Quality;
      • 2 - значение сигнала Insert.Name;
      • 3 - значение сигнала Insert.Value;
      • 4 - значение сигнала Insert.Id;
      • 5 - значение сигнала Insert.Time.

      Для сигнала Insert.Time задано значение параметра ParamValuePropID, равное 4. Это значит, что в параметр запроса ? с порядковым номером 5 будет подставлено значение свойства 4 (Timestamp) сигнала Insert.Time.

      Если требуется вводить метку времени вручную и в параметр запроса ? подставлять введённое значение, то поле ParamValuePropID нужно оставить пустым.

      В БД тип данных столбца timestamp (timestamp without time zone) не совпадает с размерностью типа сигнала Alpha.Server Insert.Time (string), поэтому в настройках модуля параметру Неявное приведение ODBC типов большей размерности к типам меньшей размерности установите значение Да.

    2. В результате выполнения запроса NewData в таблицу tank_db будет добавлена новая строка, в которой значения столбцов:

      • id равно значению сигнала Insert.Id;
      • param_name равно значению сигнала Insert.Name;
      • value равно значению сигнала Insert.Value;
      • quality равно значению сигнала Insert.Quality;
      • timestamp равно значению свойства 4 (Timestamp) сигнала Insert.Time.
  5. Запрос Delete и адреса сигналов логического типа Delete:

    1. Значение сигнала Delete.Id будет подставлено в текст запроса Delete в параметр запроса ? с порядковым номером 1.
    2. Значение сигнала Delete.Name будет подставлено в текст запроса Delete в параметр запроса ? с порядковым номером 2.
    3. В результате выполнения запроса Delete из таблицы tank_db будет удалена строка, в которой значение столбца id равно значению сигнала Delete.Id, а имя параметра в столбеце param_name соответствует значению сигнала Delete.Name.

Выполнение запроса по команде

Чтобы модуль SQL Клиент отправлял запрос в источник по команде, в настойках запроса параметру Период исполнения запроса, мс установите значение 0.

Для такого запроса модуль создаёт служебные сигналы выполнения запроса по команде, полный тег которых:

Service.Modules.<Имя модуля>.<Имя источника>.<Имя запроса>.<Имя сигнала>

Сигнал Тип Описание сигнала
MakeQuery_Command

bool

Команда выполнения запроса:

  • True - выполнить запрос.

QueryInExecutionStatus

bool

Статус выполнения запроса:

  • True - запрос выполняется;
  • False - запрос не выполняется.

Применение конфигурации Alpha.Server

  1. Постройте решение. Конфигурация Alpha.Server будет построена.

  2. Перейдите в Мастер развёртывания.

    Для успешного применения построенных конфигураций должен быть настроен Alpha.Domain. Описание настройки приведено в документации на Alpha.Domain (см. раздел Конфигурирование руководства администратора).

  3. Примените конфигурацию к Alpha.Server.