Функциональный блок ExportEventsArchive служит для экспорта архива сообщений в csv-файл.
Важно! Для возможности работы c ФБ ExportEventsArchive в исполнительную систему должна входить опция MSRT4D-ArchiveExp. Данная опция включена в базовый функционал лицензий Professional и Enterprise.
Этот функциональный блок может использоваться как самостоятельно (вне программ), так и в составе любой программы. Данный ФБ работает только в задачах узла.
Работает с сообщениями, которые уже находятся в базе данных.
Находится в библиотеке BaseObjects.
Вид в дереве |
Вид в редакторе FBD |
|
|
Входы и выходы ФБ:
Название |
Тип |
Назначение |
Входы |
||
Archive |
REF_TO |
Указывается связь с архивом. Можно перетащить Основной архив сообщений или Архив сообщений ИБ на вход левой кнопкой мыши, либо указать ID нужного архива в данном свойстве. |
Run |
BOOL |
Запускает процесс сохранения файла по переднему фронту. Если файл с таким же именем в той же папке уже существовал ранее, то файл перезапишется. |
Fields |
STRING |
Перечисляются список полей, которые необходимо сохранить. Значения полей (параметры тревоги) вводятся через запятую. Указываются программные имена полей (параметров). Список полей и их программные имена смотрите в разделах Тревога и Список программных имен параметров тревог. |
Path |
STRING |
Указывается путь к папке, в которую сохранится файл. Можно указывать как локальную, так и сетевую папку. Если значение входа не указано, то файл создастся рядом с файлом EventsData.db |
FileName |
STRING |
Задается имя сохраняемого файла. Если вход не задан, то имя файла сформируется автоматически. Имя будет состоять из даты и времени сохранения. Для указания имени можно использовать символы кириллицы и латиницы. |
Encoding |
Encoding |
Определяет кодировку файла. Возможные варианты: •UTF8 (по умолчанию), •CP1251, •ASCII. |
StartTime |
DT |
Указывается время, с которого необходимо начать экспорт сообщений. Если указано значение 0, то экспорт производится с начала архива. |
EndTime |
DT |
Указывается время, до которого необходимо выполнить экспорт сообщений. Если указано значение 0, то экспорт производится до конца архива. |
Clear |
BOOL |
Определяет необходимость очистки архива после экспорта. Если вход принимает значение TRUE, то после экспорта происходит удаление архива целиком, если вход EndTime не задан. Если вход используется, удаляются записи с начала и до указанного времени. Во время экспорта не выполняется запись в архив, новые значения остаются в очереди записи, поэтому после очистки архива неэкспортированные записи поступят в архив и не будут потеряны при удалении архива. |
Filter |
STRING |
Фильтр определяет, какие сообщения должны быть экспортированы из архива. |
Kind |
BaseObjects.DateTimeKind |
Определяет тип времени UTC. •Локальное/Local - Учитывает смещение времени относительно UTC. Поддержка на летнее время отсутсвует. •Заданное/Custom - Смещение относительно UTC задается вручную с помощью дополнительного параметра Offset. |
Offset |
TIME |
Определяет смещение времени относительно UTC в часах и минутах. Используется только при Kind=Custom. |
Выходы |
||
Running |
BOOL |
Информирует, что идет формирование файла экпорта. Этот выход принимает значение TRUE на время сохранения файла. |
Completed |
BOOL |
Сигнализирует об окончании формирования файла экспорта. После завершения выход принимает значение TRUE. Принимает значение FALSE после того, как вход Run принимает значение TRUE. |
ErrorText |
STRING |
Указывается текст ошибки, если не удалось выполнить сохранение. |
Смотрите также: