Inpolus Registry 
Inpolus ESB 1.11
Inpolus Registry
Inpolus SchedulerРуководство пользователя Реестра Сервисов
5.Эксплуатация.
5.2.Работа с базовыми объектами.
5.2.2.Создание базового объекта.
Переход в режим создания нового базового объекта осуществляется при помощи кнопки «Создать» (раздел 5.2.1. «Просмотр списка сервисов», рисунок 56, позиция 4; раздел 5.2.1. «Просмотр списка сервисов», таблица 26, пункт 4). Откроется страница создания базового сервиса (рисунок 57), в которой описания полей для каждого типа возвращаемых данных полностью соответствует их описанию для объекта данных, приведённому в разделе 5.1.5.2 «Конфигурация источника», рисунок 26 и 5.1.5.2 «Конфигурация источника», таблица 12.
| № | Инструмент | Действие |
|---|---|---|
| Флажок аудита | Включает ведение аудита — отправку обработанного сообщения в отдельный лог для просмотра. | |
| Поле «Наименование» | Предназначено для ввода наименования базового сервиса, которое потом отображается в столбце «Наименование» (раздел 5.1.5.2. «Конфигурация источника», рисунок 26, позиция 3; раздел 5.1.5.2. «Конфигурация источника», таблица 12, пункт 3). | |
| Таймаут ожидания ответа | Время ожидания ответа на запрос, мсек. | |
| Выпадающий список «Тип» | Указывает тип возвращаемых базовым объектом данных. | |
| Кнопка «Создать» | Создаёт новый базовый объект и запускает его редактирование (раздел 5.2.3. «Редактирование базового объекта»). | |
| Кнопка «Закрыть» | Отменяет создание базового объекта и выполняет переход обратно к странице базовых объектов (раздел 5.2.1. «Просмотр базовых объектов»). Если в базовом объекте остались несохранённые изменения, то при выходе будет предложено их сохранить в диалоге. |
Каждый тип объекта имеет уникальный набор полей и настроек, соответствующих формату обрабатываемых данных.
| Параметр | Тип | Обязательность | Описание | Примечание |
|---|---|---|---|---|
| Наименование | Текстовое поле | Да | Уникальное имя базового объекта. | Максимум — 100 символов. |
| Тип | Выпадающий список | Да | Формат данных: XML, JSON, SQL, TEXT. | Значение фиксируется при создании. |
| Показать XSD | Кнопка | Нет | Открывает модальное диалоговое окно с XML Schema Definition (XSD), сгенерированной на основе структуры полей базового объекта. | Доступна только если базовый объект уже сохранён. Не отображается для объектов типа TEXT. Недоступна в режиме создания (до первого сохранения). |
| Таймаут ожидания ответа, миллисекунд | Числовое поле | Нет | Время ожидания ответа от внешней системы в миллисекундах. | Диапазон: от 0 до 9999999. |
| Аудит включён | Флажок (checkbox) | Нет | Флаг включения аудита операций. Указывает, следует ли вести аудит операций, связанных с использованием этого базового объекта в сервисах. | Значение по умолчанию — не включён. Параметр задаётся на уровне всего базового объекта, а не для отдельных его полей или направлений (вход/выход). |
| Автор | Текстовое поле | — | Логин создателя. Заполняется автоматически на основании данных авторизации пользователя. | Только для чтения. |
| Дата создания | Текстовое поле | — | Дата и время создания. Заполняется автоматически при создании объекта. | Только для чтения, формат: ДД.ММ.ГГГГ ЧЧ:мм:сс. |
| Редактировал | Текстовое поле | — | Логин последнего редактора. Заполняется автоматически на основании данных авторизации пользователя. | Только для чтения. |
| Дата изменения | Текстовое поле | — | Дата и время последнего изменения. Заполняется автоматически при редактировании объекта. | Только для чтения, формат: ДД.ММ.ГГГГ ЧЧ:мм:сс. |
Важно: Поля «Автор», «Дата создания», «Редактировал», «Дата изменения» заполняются автоматически системой и недоступны для редактирования.
Специфические параметры по типам.
1. Тип JSON.
У типа JSON нет дополнительных специфических полей: он использует только общие параметры, перечисленные выше.
2. Тип XML.
Для работы с XML-форматом данных доступны дополнительные параметры, определяющие пространство имён и префиксы элементов.
| Параметр | Тип | Обязательность | Описание | Примечание |
|---|---|---|---|---|
| Пространство имён (namespace) | Текстовое поле | Нет | URI, определяющий пространство имён XML. Используется при генерации XML-сообщений, чтобы корректно сформировать теги с префиксом. | Ожидается URL-формат (например, http://example.com/ns), но технически можно ввести любую строку. |
| Префикс имён элементов | Текстовое поле | Нет | Короткое имя (алиас), которое используется в XML-документе для обозначения элементов, принадлежащих определённому пространству имён. | Если не указан, то система может использовать пустой префикс или автоматически сгенерировать его. |
3. Тип SQL.
Эти параметры позволяют точно настроить, как и что именно будет выполнять SQL-запрос, что даёт максимальную гибкость при интеграции с любыми базами данных.
| Параметр | Тип | Обязательность | Описание | Примечание |
|---|---|---|---|---|
| Строка SQL-запроса | Текстовая область | Да | Основной SQL-запрос (SELECT/INSERT/UPDATE/DELETE). | При включении режима вызова хранимой процедуры call/exec, наименование поля меняется на «Имя хранимой процедуры и параметры вызова». |
| Resultset | Флажок (checkbox) | Нет | Указывает, возвращает ли SQL-запрос (или хранимая процедура) результат в виде таблицы данных (набора строк). | Если флаг включён, то система ожидает, что после выполнения запроса появится набор строк и будет пытаться его обработать. Если флаг выключен, то ожидается только статус выполнения (успех/ошибка) и количество изменённых строк. |
| call/exec | Флажок (checkbox) | Нет | Режим вызова хранимой процедуры. Переключает объект данных из режима выполнения обычного SQL-запроса в режим вызова хранимой процедуры. | При включении заголовок меняется на «Имя хранимой процедуры и параметры вызова» и в это поле записывается вызов процедуры. |
| Использовать алиасы | Флажок (checkbox) | Нет | Генерация алиасов в SQL-запросе. | Указывает, что система должна автоматически генерировать алиасы для полей результата, чтобы избежать конфликтов имён при сложных запросах или соединениях (JOIN). |
| Максимальное количество строк | Числовое поле | Нет | Ограничение на количество возвращаемых строк. | Диапазон: от 0 до 99999. |
| Параметр | Тип | Обязательность | Описание | Примечание |
|---|---|---|---|---|
| Текст запроса | Текстовая область | Нет | Многострочное текстовое поле. Позволяет вводить длинные и структурированные тексты, например, целые JSON/XML-документы, SQL-скрипты, шаблоны сообщений и так далее. | Произвольный текст запроса или тела сообщения. |
Особенности работы.
- Автоматическое заполнение служебных полей: поля «Автор», «Дата создания», «Редактировал» и «Дата изменения» заполняются автоматически и недоступны для редактирования.
- Отображение XSD-схемы: для объектов типа XML, SQL и JSON доступна кнопка «Показать XSD», которая генерирует и отображает XML-схему структуры объекта.
Валидация данных и ограничения.
- Поля «Наименование» и «Тип» являются обязательными: при пустом значении кнопка «Создать» не срабатывает и появляется сообщение «поле не заполнено».
- Ограничение на удаление: удаление базового объекта запрещено, если он используется хотя бы в одном сервисе. Кнопка «Удалить» а этом случае неактивна.
Рекомендации для пользователя.
- Включайте аудит, если базовый объект используется в критически важных сервисах, где необходима детальная история всех операций. Отключайте аудит для вспомогательных или тестовых объектов, чтобы не засорять логи. Статус аудита не наследуется: если вы создадите сервис на основе базового объекта с включённым аудитом, то сам сервис может иметь собственные настройки логирования.
- Избегайте частых изменений структуры базовых объектов, используемых в сервисах — это может привести к сбоям.
- Перед удалением базовых объектов всегда проверяйте вкладку «Связанные сервисы»: таблица внизу формы редактирования показывает все сервисы, где используется базовый объект.
- Используйте понятные и отражающие назначение имена базовых объектов.