orig-crc32 Оригинальный CRC32 файла. for-export Разрешен экспорт данного файла. export-doc-filename Служебное, автоматически генерируемое, имя файла


Realty-Robot
Версия 6.81.86

Руководство поЛЬЗОВАТЕЛЯ

Ревизия руководства: 6





13 TOC \o "1-3" \h \z \u 1413 LINK \l "_Toc492931417" 141. Назначение и основные характеристики 13 PAGEREF _Toc492931417 \h 1421515
13 LINK \l "_Toc492931418" 142. Установка и подготовка к работе 13 PAGEREF _Toc492931418 \h 1421515
13 LINK \l "_Toc492931419" 143. Совместимость с другим программным обеспечением 13 PAGEREF _Toc492931419 \h 1431515
13 LINK \l "_Toc492931420" 144. Файл настроек Realty-Robot.xml 13 PAGEREF _Toc492931420 \h 1451515
13 LINK \l "_Toc492931421" 145. Сценарии и задачи 13 PAGEREF _Toc492931421 \h 1481515
13 LINK \l "_Toc492931422" 146. Сценарии 13 PAGEREF _Toc492931422 \h 1491515
13 LINK \l "_Toc492931423" 146.1. Файл-индикатор готовности 13 PAGEREF _Toc492931423 \h 1491515
13 LINK \l "_Toc492931424" 146.2. Общие настройки сценариев 13 PAGEREF _Toc492931424 \h 1491515
13 LINK \l "_Toc492931425" 146.3. Сценарий экспорта 13 PAGEREF _Toc492931425 \h 14131515
13 LINK \l "_Toc492931426" 146.3.1. Настройки 13 PAGEREF _Toc492931426 \h 14131515
13 LINK \l "_Toc492931427" 146.3.2. Алгоритм 13 PAGEREF _Toc492931427 \h 14171515
13 LINK \l "_Toc492931428" 146.3.3. Формат Realty-Robot 13 PAGEREF _Toc492931428 \h 14181515
13 LINK \l "_Toc492931429" 146.4. Сценарий экспорта 13 PAGEREF _Toc492931429 \h 14211515
13 LINK \l "_Toc492931430" 146.5. Сценарий импорта 13 PAGEREF _Toc492931430 \h 14221515
13 LINK \l "_Toc492931431" 146.5.1. Настройки 13 PAGEREF _Toc492931431 \h 14221515
13 LINK \l "_Toc492931432" 146.5.2. Алгоритм 13 PAGEREF _Toc492931432 \h 14251515
13 LINK \l "_Toc492931433" 146.6. Сценарии копирования между локальным каталогом и FTP-каталогом 13 PAGEREF _Toc492931433 \h 14251515
13 LINK \l "_Toc492931434" 146.6.1. Общие настройки сценариев и 13 PAGEREF _Toc492931434 \h 14251515
13 LINK \l "_Toc492931435" 146.6.2. Алгоритм сценария 13 PAGEREF _Toc492931435 \h 14271515
13 LINK \l "_Toc492931436" 146.6.3. Алгоритм сценария 13 PAGEREF _Toc492931436 \h 14271515
13 LINK \l "_Toc492931437" 146.7. Сценарий выполнения внешней программы 13 PAGEREF _Toc492931437 \h 14281515
13 LINK \l "_Toc492931438" 146.8. Составной сценарий 13 PAGEREF _Toc492931438 \h 14291515
13 LINK \l "_Toc492931439" 146.9. Заказные сценарии 13 PAGEREF _Toc492931439 \h 14291515
13 LINK \l "_Toc492931440" 147. Шаблоны сценариев в Realty-Robot.xml 13 PAGEREF _Toc492931440 \h 14301515
13 LINK \l "_Toc492931441" 148. Рекомендации по разработке сценариев для распространенных ситуаций 13 PAGEREF _Toc492931441 \h 14311515
13 LINK \l "_Toc492931442" 148.1. Ситуация: анонимный импорт из xls-файла 13 PAGEREF _Toc492931442 \h 14311515
13 LINK \l "_Toc492931443" 148.2. Ситуация: обмен данными с компаниями-партнерами 13 PAGEREF _Toc492931443 \h 14321515
13 LINK \l "_Toc492931444" 148.3. Ситуация: обмен данными между главным офисом компании и филиалами 13 PAGEREF _Toc492931444 \h 14321515
13 LINK \l "_Toc492931445" 149. Рекомендуемый алгоритм работы скрипта импорта на сайте 13 PAGEREF _Toc492931445 \h 14331515
13 LINK \l "_Toc492931446" 1410. Работа с Realty-Robot 13 PAGEREF _Toc492931446 \h 14341515
13 LINK \l "_Toc492931447" 1411. Протоколирование действий Realty-Robot 13 PAGEREF _Toc492931447 \h 14351515
13 LINK \l "_Toc492931448" 1411.1. Протокол задач 13 PAGEREF _Toc492931448 \h 14351515
13 LINK \l "_Toc492931449" 1411.2. Системный протокол 13 PAGEREF _Toc492931449 \h 14351515
15



Назначение и основные характеристики

Программа Realty-Robot (исполняемый файл Realty-Robot.exe) предназначена для выполнения в автоматическом режиме различных задач в рамках системы Агентство недвижимости (исполняемый файл Realty.exe) варианта «Люкс».

Основные возможности Realty-Robot:
Выполнение стандартных сценариев:
Сценарий экспорта в формате Realty-Robot
Сценарий экспорта в формате YRL (Yandex Realty Language) для сервиса Яндекс.Недвижимость
Сценарий импорта из формата Realty-Robot
Сценарий копирования из локального каталога в каталог на FTP-сервере
Сценарий копирования из каталога на FTP-сервере в локальный каталог
Сценарий запуска внешних программ.
Составной сценарий, позволяющий задать последовательность запуска других сценариев.
Возможна разработка заказных сценариев.
Способ запуска задач по выполнению сценариев может быть указан как:
По расписанию
Через заданный интервал
Немедленно по запросу пользователя
В главном окне Realty-Robot отображается список задач на текущий день с возможностью установки фильтра по их статусам: Ожидает, Работает, Завершена, Не выполнены условия запуска, Ошибка.

Примечание: Realty-Robot предлагается как универсальная замена всех имевшихся к данному моменту способов обмена данными в системе Агентство недвижимости.
Установка и подготовка к работе

Во время установки системы Агентство недвижимости программы Realty.exe и Realty-Robot.exe по умолчанию копируются в общий каталог:
<Диск>:\Program Files\Realty-Soft.ru\Realty\Realty.exe
<Диск>:\Program Files\Realty-Soft.ru\Realty\Realty-Robot.exe

Ярлыки для запуска Realty.exe и Realty-Robot.exe автоматически помещаются на рабочий стол. После установки необходимо предоставить все права на каталог \Realty-Soft.ru и его подобъекты для пользователя, который будет работать с программой. Один из простых способов удовлетворить это требование – указать в свойствах этих ярлыков возможность запуска от имени администратора: правая кнопка мыши на ярлыке ( Свойства ( Совместимость ( Выполнять эту программу от имени администратора.










Для работы Realty-Robot требуется платформа Microsoft .NET Framework 4.6. В Windows 10 эта платформа уже установлена. Если же компьютер работает под управлением одной из ОС:
Windows Vista с пакетом обновления 2 (SP2) (x86 и x64)
Windows 7 с пакетом обновления 1 (SP1) (x86 и x64)
Windows 8 (x86 и x64)
Windows 8.1 (x86 и x64)
Windows Server 2008 с пакетом обновления 2 (SP2) (x86 и x64)
Windows Server 2008 R2 с пакетом обновления 1 (SP1) (x64)
Windows Server 2012 (x64)
Windows Server 2012 R2 (x64)

и на момент первого запуска Realty-Robot платформа еще не установлена – будет выведено соответствующее сообщение. Платформу можно бесплатно скачать и установить с официального сайта Microsoft по ссылке: [ Cкачайте файл, чтобы посмотреть ссылку ].

Перед началом повседневной (не демонстрационной) работы с Realty-Robot необходимо отредактировать файл настроек Realty-Robot.xml, в т.ч. настроить сценарии в соответствии с требованиями бизнес-процессов компании (см. следующие разделы).
Совместимость с другим программным обеспечением

Если на компьютере установлены Kaspersky Internet Security или Kaspersky Total Security, возможно блокирование с их стороны запросов к FTP-серверам (в процессе работы сценариев копирования на/с FTP). Для разблокировки нужно сделать следующие настройки (на примере KTS 2016):

Настройка:














Дополнительно:



Сеть:

















Контролировать только выбранные порты ( Выбрать:


И отключить контроль активности порта 21.
Файл настроек Realty-Robot.xml

При установке Realty-Robot.exe в один с ним каталог помещается файл настроек Realty-Robot.xml.
Наличие и корректное содержание данного файла являются необходимыми для запуска и работы Realty-Robot.

Пример структуры верхних элементов xml-документа:




true
600<
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·
·>Импорт от Компании А



Экспорт для Компании Б








Элемент содержит настройки приложения Realty-Robot в целом:

Элемент
Комментарий

window-height
Назначение:
Хранят расположение и размеры главного окна Realty-Robot для восстановления при следующем запуске программы.

Тип значения:
Целое

Пример:
600
1200
100
100

При отсутствии:
Создаются автоматически со значениями: 600, 1200, 360, 340 (под монитор Full-HD)

window-width


window-left


window-top


font-family
Назначение:
Семейство шрифта в окнах Realty-Robot

Тип значения:
Строка

Пример:
Arial

При отсутствии:
Считается Arial

font-size
Назначение:
Размер шрифта в окнах Realty-Robot

Тип значения:
Целое

Пример:
16

При отсутствии:
Считается 12

auto-start
Назначение:
Необходимость автозапуска таймера Робота при старте приложения. Если при старте приложения необходимо сразу же запустить таймер Робота для отслеживания времени запуска задач и их запуск в нужное время, необходимо установить значение в true. По умолчанию установлено значение false, т.е. после старта приложения пользователь для запуска таймера Робота должен воспользоваться кнопкой Старт.

Тип значения:
Булево: true, false

Пример:
true

При отсутствии:
Считается false

db-connection-string
Назначение:
Строка подключения к базе данных системы Агентство недвижимости.

Тип значения:
Строка

Пример:

data source=localhost; initial catalog=c:\Program Files\Realty-Soft.ru\Realty\realty7777.fdb;
dialect=3;user id=sysdba;password=masterkey;character set=WIN1251;
pooling=False


При отсутствии:
Realty-Robot будет читать строку подключения из файла Realty.sys, который используется для этой же цели и программой Realty.exe. Такой способ является рекомедуемым, т.к. открытое указание user id и password в строке подключения значительно снижает защищенность базы данных.

log-mode-service
Назначение:
Если установлено значение true – Realty-Robot включает сервисный (очень подробный) режим протоколирования своих действий с сохранением их в лог-файл. Режим может быть полезен для диагностики проблемных ситуаций. Следует учесть, что включение режима несколько замедляет работу Realty-Robot. Подробнее о протоколировании см. в следующих разделах.

Тип значения:
Булево: true, false

Пример:
true

При отсутствии:
Считается false


Элементы сценариев , и др. (имена начинаются с «scenario-») содержат настройки конкретных сценариев и подробно рассматриваются далее.
Сценарии и задачи

Основными объектами, которыми оперирует Realty-Robot, являются сценарии и задачи.
Сценарий – формализованное описание некоторого набора типовых действий. Задача – выполнение сценария с некоторой привязкой ко времени/условиям. Описания сценариев и способы запуска задач хранятся в файле Realty-Robot.xml.

Например, пусть имеется следующий файл Realty-Robot.xml:




false
600
1200
360
340


Импорт из АН Пирамида
interval
600
true
c:\Realty\import\ИмпортИзАНПирамида
c:\Realty\arc
false
true




В этом файле описан некоторый сценарий импорта под именем Импорт из АН Пирамида. Указан интервальный способ запуска с периодичность 600 сек (10 мин). Перед непосредственным импортом заявок в БД все заявки, которые ранее были импортированы в БД от узлов-источников, которые встретятся в импортируемых заявках, удаляются. Полагается, что импортируемые данные уже находятся в локальном каталоге c:\Realty\import\ИмпортИзАНПирамида. По завершении импорта в БД создается их архивная копия в каталоге c:\Realty\arc, а сам локальный каталог очищается.

Таким образом то, что формализовано в элементе , является сценарием. А задачи для импорта по этому сценарию будут динамически создаваться и запускаться роботом каждые 10 минут. Если бы способ запуска был указан как schedule, т.е. по расписанию, то вместо элемента 600 в сценарии должен был присутствовать элемент примерно такого содержания:





т.е. задачи импорта динамически создавались и запускались бы каждые сутки в 10:00, 14:00, 17:00.

Визуальное отображение запланированных на сегодня задач и состояние их выполнения отображаются в главном окне Realty-Robot (см. далее).




Сценарии
Файл-индикатор готовности

Перед дальнейшим рассмотрением сценариев (экспорта, импорта и копирования) необходимо упомянуть о служебном файле-индикаторе готовности, имеющем имя ready.flag. Содержимое файла не важно (Realty-Robot всегда создает его пустым), важно только его наличие/отсутствие. Предназначение файла-индикатора – исключение коллизий совместного доступа разных сценариев/процессов при доступе к одному и тому каталогу: на локальном компьютере или на FTP-сервере .

Основные правила применения файла-индикатора таковы:
Если задача должна записывать в каталог, она может это начать делать, только
если каталог (подкаталоги не имеют значения) пуст. Задача должна максимально быстро
записать в каталог первый файл. После окончания записи самым последним действием
в своей работе задача должна создать в каталоге файл ready.flag, что означает завершенность работы. Маловероятная коллизия может произойти только в случае, когда две стороны проверили каталог на пустоту и одновременно начали записывать в него.
Если задача читает из каталога, она может начать это делать только если в каталоге есть
файл ready.flag. При этом самым первым своим действием задача должна удалить этот флаг, чтобы
никакая другая задача (если таковая может стартовать) также не сочла каталог "готовым" и не начала
производить с ним операции чтения/записи.

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

Общие настройки сценариев

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

Элемент
Комментарий
Где используется

scenario-name
Назначение:
Имя сценария. Сценариям, описываемым в файле Realty-Robot.xml, во избежание различных коллизий следует назначать различные имена.

Тип значения:
Строка

Пример:
Импорт из АН Пирамида

При отсутствии:
Элемент обязателен.
Во всех сценариях

start-mode
Назначение:
Способ запуска задачи:
schedule: Задачи для данного сценария запускаются в назначенные моменты времени каждые сутки
interval: Задачи для данного сценария запускаются в цикле с интервалом минут
manually: Задачи для данного сценария могут быть запущены только пользователем вручную (в главном окне Realty-Robot кнопка Однократно).

Тип значения:
Перечисление: schedule, interval, manually

Пример:
interval

При отсутствии:
Считается manually
Во всех сценариях

run-schedule
Назначение:
Запуск задач для данного сценария Realty-Robot будет пробовать осуществить в моменты, указанные во вложенных элементах

Приложенные файлы

  • doc 7710543
    Размер файла: 758 kB Загрузок: 0

Добавить комментарий