Alpha.Community

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

Запись данных в файл-срез

Модуль Snapshot записывает текущие значения сигналов Alpha.Server в файл-срез по указанному в служебном сигнале шаблону. В файл-срез записываются значения/свойства только тех сигналов Alpha.Server, которые указаны в шаблоне файла-среза. Сигналы в шаблоне могут быть заданы тегами или индексами.

Чтобы модуль Snapshot смог сгенерировать файл-срез, шаблон файла-среза должен быть выполнен в исходном формате. Под исходным форматом понимается структура шаблона, с которой может работать Alpha.Server. Файл-срез, генерируемый по такому шаблону, также именуется исходным. Для получения файла-среза исходного формата подготавливается шаблон и выполняется запись данных в файл-срез исходного формата. Описания и примеры шаблона и файла-среза исходных форматов приведены в разделах:

Если необходимо получить файл-срез со структурой отличной от исходной и шаблон имеет сторонний формат, то потребуется применить к шаблону и файлу-срезу соответствующие XSLT-преобразования. Для получения файла-среза стороннего формата:

В рамках данного руководства не рассматриваются правила формирования и не содержатся инструкции по созданию файлов, содержащих xsl-правила и xsd-схемы. Однако, при их создании необходимо учесть обязательные элементы и атрибуты, которые указаны ниже в разделе Запись данных в файл-срез стороннего формата.

Для записи данных в файл-срез укажите в настройках модуля:

  • в разделе Параметры каталогов место для записи и хранения файлов:

  • в разделе Параметры генерации файлов-срезов способ задания места для записи файлов:

Параметр Описание
Параметры каталогов
Каталог файлов-срезов

Путь до папки, в которую генерируются файлы-срезы.

По умолчанию путь: С:\FSModule\

Каталог с шаблонами файлов-срезов

Путь до папки, в которой располагаются шаблоны файлов-срезов (*.xml) и файлы xsl-правил преобразования (*.xsl).

Путь по умолчанию: С:\FSModule\Templates\

Параметры генерации файлов-срезов
Генерировать файлы-срезы по абсолютному пути

Возможность указывать в сигнале OutFileName абсолютный путь для генерации файла-среза:

  • Да – в сигнале OutFileName указывается абсолютный путь для генерации файла-среза;
  • Нет – модуль сохраняет сгенерированный файл-срез в каталог, указанный в параметре Каталог файлов-срезов, а в сигнале OutFileName указывается только имя генерируемого файла.

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

Запись данных в файл-срез исходного формата

Запись данных в файл-срез исходного формата выполняется в момент генерации файла-среза на основании шаблона исходного формата.

Для записи значений сигналов Alpha.Server в файл-срез исходного формата:

  1. Создайте файл шаблона файла-среза в формате *.xml (например, MyTemplate.xml) и разместите в папку, указанную в параметре модуля Каталог с шаблонами файлов-срезов.
  2. В значении сигнала TemplateName ветки Generator укажите имя файла подготовленного шаблона без расширения:

  3. В значении сигнала OutFileName ветки Generator укажите имя генерируемого файла-среза:

    Если имя не указано, то при генерации файлу-срезу присваивается имя в формате:

    <имя шаблона без расширения> <дата и время генерации DD-MM-YYYY HH-MM-SS>.xml

    Дата и время генерации в имени файла – локальные системные.

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

  5. В значении сигнала SnapShotDescription ветки Generator укажите, если это необходимо, описание для файла-среза.
  6. Подайте команду на генерацию файла-среза: в сигнал Generate ветки Generator запишите значение True.

Запись данных в файл-срез стороннего формата

Алгоритм генерации файла-среза стороннего формата:

  1. Шаблон стороннего формата преобразуется в шаблон исходного формата по xsl-правилам.
  2. На основе полученного шаблона исходного формата генерируется файл-срез исходного формата.
  3. Полученный файл-срез исходного формата преобразуется в файл-срез стороннего формата по xsl-правилам.
  4. Файл-срез стороннего формата проходит проверку на соответствие xsd-схеме, заданной в xsl-правилах преобразования.

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

Для записи значений сигналов Alpha.Server в файл-срез стороннего формата:

  1. Создайте и разместите в папку, указанную в параметре модуля Каталог с шаблонами файлов-срезов:

    • файл в формате *.xml шаблона стороннего формата (например, MyTemplate.xml);
    • файл в формате *.xsl, содержащий правила преобразования шаблона стороннего формата в шаблон исходного формата (например, ToOriginalTemplate.xsl);

      В xsl-файле правил преобразования шаблона стороннего формата в шаблон исходного формата укажите:

      • значение элемента name равным SnapShotTemplate (<xsl:element name="SnapShotTemplate">);
      • значение атрибута name равным Name (<xsl:attribute name="Name">).
    • файл в формате *.xsl, содержащий правила преобразования среза исходного формата в срез стороннего формата и ссылку на схему для проверки среза на соответствие нужному формату (например, ToOther.xsl).
  2. Создайте файл в формате *.xsd, в котором укажите схему соответствия среза стороннему формату.
  3. Разместите файл в формате *.xsd в каталоге по пути, указанному в подготовленном файле xsl-правил преобразования среза исходного формата в срез стороннего формата.
  4. В значении сигнала TemplateName ветки Generator укажите имя файла подготовленного шаблона без расширения:

  5. В значении сигнала TemplateTransformRulesFileName ветки Generator укажите имя файла, содержащего xsl-правила преобразования шаблона стороннего формата в шаблон исходного формата, без расширения:

    Если в сигнале TemplateTransformRulesFileName не указано имя файла, то шаблон рассматривается как исходный.

  6. В значении сигнала TransformRulesFileName ветки Generator укажите имя файла, содержащего xsl-правила преобразования среза исходного формата в срез стороннего формата, без расширения:

  7. В значении сигнала OutFileName ветки Generator укажите имя генерируемого файла-среза:

    Если имя не указано, то при генерации файлу-срезу присваивается имя в формате:

    <имя шаблона без расширения> <дата и время генерации DD-MM-YYYY HH-MM-SS>.xml

    Дата и время генерации в имени файла – локальные системные.

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

  8. В значении сигнала SnapShotDescription ветки Generator укажите, если это необходимо, описание для файла-среза.
  9. Подайте команду на генерацию файла-среза: в сигнал Generate ветки Generator запишите значение True.

Результат генерации

Сгенерированный файл-срез сохраняется в папку, указанную в параметре модуля Каталог файлов-срезов.

Количество сигналов, попавших в файл-срез, отображается в сигнале GenSignalCount ветки Generator. Если сигналы, указанные в шаблоне, отсутствуют в конфигурации Alpha.Server, то формируется пустой файл-срез и значение сигнала GenSignalCount принимает значение 0.

Сообщения об ошибках

Сообщения об ошибках, возникающих при записи данных в файл-срез, записываются в журнал работы модуля Snapshot. Cигнал GenLastError ветки Generator содержит информацию о последней неудачной попытке сгенерировать файл-срез. Ошибки генерации файла-среза могут возникнуть:

  • при отсутствии в Каталоге с шаблонами файлов-срезов шаблона, указанного в сигнале TemplateName ветки Generator;
  • при обнаружении несоответствия формата шаблона файла-среза формату XML;
  • при выявлении несоответствия полученного файла-среза стороннего формата заданной схеме (*.xsd).

Несоответствие полученного файла-среза стороннего формата заданной схеме (*.xsd) не влияет на генерацию файла-среза. Файл-срез генерируется и может быть использован для последующего восстановления данных на Alpha.Server.