Алгоритм получения настроек с сервера во внешнюю обработку

ВО СБИС поддерживает два варианта хранения файлов настроек: "в каталоге" и "в СБИС". В первом варианте настройки находятся на локальном диске, путь до папки указывается в настройках обработки, и сохраняется в пользовательских параметрах 1С. Основной недостатком является необходимость общего доступа к каталогу и более сложная настройка в Linux и клиент-серверных версиях 1С, не работает в веб клиентах 1С.

Во втором варианте настройки хранятся в СБИС, в пользовательских параметрах 1С хранится только идентификатор настройки. Данный способ доступен только для при использовании способа обмена extSDK, либо extSDKCrypto. Данный вариант избавлен от недостатков, а также имеет дополнительный функционал - общие настройки. Можно создать для всех настройки по-умолчанию, которые автоматически будут применяться у пользователей при запуске обработки на этой базе 1С.

Алгоритм загрузки файла настроек из СБИС

1. Идентификатор настройки (ConnectionID) отсутствует в пользовательских параметрах

1.1. Проверяем имеются ли для данной базы 1С общие настройки, либо настройка уже проводилась, но по какой-либо причине, ConnectionID в обработке не сохранился. Например: настраиваем обработку пользователю первый раз. Либо у пользователя был очищен кэш 1С (актуально для конфигураций, работающих на обычных формах)

• Получаем список настроек ReadConnectionList. Сразу получаем сбис меню, в котором содержится информация по составу настроек и тому, какие файлы включены, а какие - нет.
  • Параметры вызова:
    • service - идентификатор сервиса ВО 1С - Com1C82
    • URL - строка соединения базы данных.
    • ini - массив со структурой, вида: ключ - строка "ini_type", значение - строка "Меню".
• Если список соединений пуст, переходим к процедуре выбора подходящих стандартных настроек (Пункт 3).

1.2. Берём первое соединение из полученного списка. Список построен таким образом, что сперва идут настройки, которые сохранены только для выбранного пользователя, а затем общие для аккаунта.

• Кэшируем сбисМеню выбранного соединения, чтобы в дальнейшем не получать повторно.

1.3. Переходим к получению выбранных настроек. (Пункт 2).

2. Идентификатор настройки (ConnectionID) указан в пользовательских настройках

2.1. Составляем список файлов настроек, которые необходимо получить.

• 2.1.1. Получаем сбис меню, в котором содержится информация по составу настроек и тому, какие файлы включены, а какие - нет.
  • Проверяем наличие файла сбис меню в кэше по выбранному ConnectionID и берём его.
• 2.1.2. Если меню нет, то читаем его с сервера по выбранному ConnectionID:
  • Читаем настройки с сервера, но не все, а только сбисМеню readConnection
    • Параметры вызова:
      • id - ConnectionID, 128 битный идентификатор соединения.
      • version - числовое представление версии системы, где каждый разряд версии, кроме первого, дополнен нулями до 4 символов. Пример: 3.2.0.11 = 3000200000011
      • ini - массив со структурой, вида: ключ - строка "ini_type", значение - строка "Меню".
    • Кэшируем полученное меню.
• 2.1.3. Читаем меню и составляем список включенных файлов настроек, которые необходимо получить.
  • Включенным считается файл с установленным флагом в поле "enable". Если один и тот же файл встречается в меню несколько раз, в разных разделах, то он должен быть везде либо включен, либо отключен.
  • Структура элементов списка:
    • Массив структур "ini" с элементами:
      • Ключ - "ini_type", значение - тип ини.
      • Ключ - "ini_name", значение - системное имя ини.

2.2. Получаем файлы настроек и сбис параметры.

• 2.2.1. Возможно, настройки, либо их часть, были получены ранее, поэтому смотрим их наличие в кэше по выбранному ConnectionID.
  • Найденные файлы исключаем из списка настроек, которые необходимо получить.
• 2.2.2. Читаем с сервера недостающие данные readConnection
  • Параметры вызова:
    • id - ConnectionID, 128 битный идентификатор соединения.
    • version - числовое представление версии системы, где каждый разряд версии, кроме первого, дополнен нулями до 4 символов. Пример: 3.2.0.11 = 3000200000011.
    • ini - массив объектов "ini", которые не удалось найти кэше. Если все файлы найдены, параметр не передаётся.
  • Кэширует полученные настройки.
• 2.2.3. Читаем структуру сбис параметров из поля "json_connection" для проверки изменений, произошедших с последнего запуска.

2.3. Проверяем настройки.

• 2.3.1. Прежде чем выполнять проверку, нужно посмотреть на изменения, которые могли произойти с момента последнего запуска обработки на этой конфигурации. Пользователь мог обновить конфигурацию базы данных, либо могли поменяться файлы настроек.
  • Для того, чтобы отследить изменения версии конфигурации, сравним значение узла "ВерсияКонфигурации" в сбис параметрах и текущую версию конфигурации - Метаданные.Версия.
  • Для того, чтобы отследить изменения файлов настроек конфигурации, сравним дату последней проверки каждой включенной настройки в сбис параметрах и поле в настройках "update_date".
• 2.3.2. Проверяем файлы настроек, если были изменения.
• 2.3.3. Оцениваем результат проверки.
  • Если проверка выполнена успешно, то вносим изменения в сбис параметры для того, чтобы при следующем получении проверка не проводилась.
    • Обновляет дату проверки в сбисПараметрах для всех включенных файлов настроек.
    • Обновляет поле "ВерсияКонфигурации" на текущую версию конфигурации - Метаданные.Версия.
  • Если в процессе проверки обнаружены ошибки, то переходим к процедуре ручной правки выбранных настроек(Пункт3)

2.4. Сохраняем выбранные настройки в обработку.

• 2.4.1. Запишем изменения на сервер.
  • 2.4.1.1. Сперва оценим, нужно ли что-то записывать на сервер.
    • Если проверка настроек проводилась, то должны были поменяться сбис параметры, а значит нужно их сохранить.
    • Если были выбраны общие настройки, то надо создать на их основе новое подключение, чтобы можно было вносить персональные правки, включать нужные и отключать ненужные файлы настроек.
  • 2.4.1.2. Подготовим параметры для записи.
    • Возьмём данные от выбранных настроек.
    • Поле "ini" не указывается.
    • Положим в поле "json_connection" сбис параметры после проверки.
    • Определим необходимость создания нового подключения. Если выбранные настройки являются общими, то выбранный ConnectionID указывается в качестве параметра "parent". Поле "id" очищается.
  • 2.4.1.3. Сохраним изменения WriteConnection.
• 2.4.2. Полученный ID сохраним в пользовательский параметр и реквизит обработки "ConnectionID".

Шаг 5. Выполняет переход в раздел(Пункт 3).

Пункт 3. Переход в раздел:

Если полученные файлы ини прошли проверку:

• Выполняет переход в раздел, установленный по-умолчанию.

Если настройки полученного соединения не прошли проверку:

• Шаг 1. Если были ошибки при проверке, показывает протокол об ошибках.
  • ВывестиПротоколПроверкиИниФайлов на форме ФайлыНастроекОбщее.

• Шаг 2. Переходит в "Настройки", подраздел "Файлы настроек".
  • ПерейтиВРаздел на форме ГлавноеОкно

• Шаг 3. Заполняет список доступных конфигураций.
  • ОбновитьКонтент на форме Раздел_Настройки_ФайлыНастроек
    • Вызывает ReadConfigList.
      • Параметры вызова:
        • service - идентификатор сервиса ВО 1С - Com1C82
    • Заполняет список, кэширует.

• Шаг 4. Проверяет наличие выбранного соединения.
  • Если соединение не выбрано:
    • а. Подбирает подходящую типовую конфигурацию.
      • ОпределитьТипНастроекПоПрефиксу на форме ФормаНастроекОбщее.
    • б. Получает меню выбранной конфигурации.
      • Проверяет меню в кэше. Если есть, берёт.
      • Если в кэше нет, получает:
        • Вызывает ReadConfig
          • Параметры вызова:
            • service - идентификатор сервиса ВО 1С - Com1C82.
            • subsystem - поле "subsystem" выбранной конфигурации.
            • version - поле "version" выбранной конфигурации.
            • ini - массив со структурой, вида: ключ - строка "ini_type", значение - строка "Меню".
        • Кэширует полученное меню.
    • в. Формирует массив имен и типов включенных ини по меню.
      • Включенной считается ини с установленным флагом в поле "enable".
      • Структура элементов массива "ini":
        • Ключ - "ini_type", значение - тип ини.
        • Ключ - "ini_name", значение - системное имя ини.
    • г. Получает ини выбранной конфигурации.
      • Проверяет ини в кэше по сформированному массиву. Если есть, берёт.
      • Если в кэше нет, вызывает ReadConfig
        • Параметры вызова:
          • service - идентификатор сервиса ВО 1С - Com1C82
          • subsystem - поле "subsystem" выбранной конфигурации.
          • version - поле "version" выбранной конфигурации.
          • ini - массив объектов "ini", которые не удалось найти кэше.
      • Кэширует полученные настройки
    • д. Выбранная конфигурация назначается выбранным соединением с пометкой создания нового при записи.
    • е. Выполняется проверка выбранного соединения.

• Шаг 5. Находит конфигурацию выбранного соединения.
  • ОпределитьТипНастроекПоПрефиксу на форме ФормаНастроекОбщее.

• Шаг 6. Получает меню выбранной конфигурации.
  • Проверяет меню в кэше. Если есть, берёт.
  • Если в кэше нет, вызывает ReadConfig
    • Параметры вызова:
      • service - идентификатор сервиса ВО 1С - Com1C82
      • subsystem - поле "subsystem" выбранной конфигурации.
      • version - поле "version" выбранной конфигурации.
      • ini - массив со структурой, вида: ключ - строка "ini_type", значение - строка "Меню".
    • Кэширует полученное меню

• Шаг 7. Строит список доступных ини.
  • ПолучитьМассивФайловДляКонфигурации на форме ФайлыНастроекСервер.
  • ПолучитьМассивУстановленныхИниФайлов на форме ФайлыНастроекСервер.

• Шаг 8. Отображает выбранные ини соединения и конфигурации.
  • сбисОбновитьТаблицыИниФайлов на форме ГлавноеОкно.
    • В левой колонке список ини полученной конфигурации.
    • В правой колонке список ини выбранного соединения.