Команды адаптера — различия между версиями

Материал из ANT-Inform documentation
Перейти к: навигация, поиск
(Import commands part from http://serverprog:1080/display/kb/imus-ais)
(нет различий)

Версия 19:30, 12 февраля 2013

Команды адаптеру и принцип работы

За каждую операцию выполняется только одно действие, обычно это загрузка одного вида объектов (например площадок) или какая-либо генерация.

Посылать команды можно 3мя способами:

  1. Через очереди ActiveMQ из браузера, в очередь AIS.CMDCONF.IN (по умолчанию адрес http://localhost:8161/)
  2. Большинство команд (об исключениях будет написано дополнительно) могут быть также посланы через АРМ.
  3. C использованием консольной утилитки amq-command

Список команд адаптера

В общем случае имена команд зависимы от регистра.

Команда Соответсвующая операция ВЕБ-сервиса Описание Доп инфо
Region get_regions Импортируются Субъекты РФ. Создаются только ПМ. требуется маппинг.
SubReg get_sub_regs Импортируются районы
IndustryGroup get_industry_groups Импортируются Группы отраслей. Создаются только ПМ. требуется маппинг.
Industry get_industrys Импортируются отрасли. Создаются только ПМ. требуется маппинг.
Consumer get_consumers Импортируются потребители
GasDistribOrg get_gas_distrib_orgs Импортируются Газораспределительные организации (ГРО)
GasDistribStation get_gas_distrib_stations Импортируются ГРС
GasDistribOut get_gas_distrib_outs Импортируются Выходы ГРС
GasConsObject get_gas_cons_objects Импортируются площадки. С дополнительными настройками также могут импортироваться пользователи АИС и зоны ответственности. Подробнее в описании опции ais.ws.responseZonesBy
PointConnect get_point_connects Импортируются Точки подключения
Tuug get_uugs Импортируются Узлы Учёта Газа (УУГ)
EquipModel get_equip_models Импортируются модели корректоров. Создаются только ПМ. требуется маппинг.
Equip get_equips Импортируются Корректоры (Вычислители)
Channel get_channels Импортируются канал
GasConsEquipClass get_gas_cons_equip_classes Импортируются классы ГПО
GasConsEquipType get_gas_cons_equip_types Импортируются Типы ГПО
GasConsEquip get_gas_cons_equips Импортируется ГПО
GasMeterType get_gas_meter_types Импортируются типы измерительного оборудования. Из-за нашей схемы, импорт ограничен только в модели ИО, не в конечные устройства, как это может быть в АИС. Данный вопрос на рассмотрении у аналитиков в задаче ESB-643.

С версии 17.0.pre2. ESB-643

GasMeterModel get_gas_meter_models Импортируются модели измерительного оборудования
GasMeter get_gas_meters Импортируется [[Перечень сокращений и обозначений#ИО|измерительное оборудование]
PriorityMark get_priority_marks Импортируются типы ценообразования Ранее, [[история изменений|до версии 15]] были виды договоров
Contract get_contracts Импортируются договоры
PurchaseContract get_purchase_contracts Импортируются договоры закупки газа С версии сервиса и адаптера 15pre5. ESB-502
TransDic get_trans_dics Импортируются подразделения ТрансГазов Создаются только ПМ.

требуется маппинг. Импортируются по новой схеме, в таблицу imus_mapping. С версии 15.0

GasProducer get_gas_producers Создаются только ПМ. требуется маппинг. Импортируются по новой схеме, в таблицу imus_mapping. C версии 15.0
AutoMapGasProducer нет Предпринимается попытка автоматически сопоставить Производителей Газа С версии 15.1pre1. ESB-508
GasSupplier get_gas_suppliers Импортируются меты Поставщиков газа Создаются только ПМ. требуется маппинг. Импортируются по новой схеме, в таблицу imus_mapping. C версии 15.0
AutoMapGasSupplier нет Предпринимается попытка автоматически сопоставить Поставщиков Газа С версии 15.1pre1. ESB-508
GasVendor get_gas_vendors Импортируются меты продавцов (владельцев) газа требуется маппинг. Импортируются по новой схеме, в таблицу imus_mapping. C версии 15pre6
AutoMapGasVendor нет Предпринимается попытка автоматически сопоставить Продавцов Газа С версии 15.1pre1. ESB-508
AutoMapTransDic нет Предпринимается попытка автоматически сопоставить отделений Трансгаза С версии адаптера 15.11.1. ESB-565
(deprecated in С появления CcDailyPlan) AttachPcToContract get_relation_point_connect_to_contract Осуществляется связка договоров с ТП С момента появления CcDailyPlan объявляется устаревшей и будет удалена из следующих версий.
(deprecated in С появления CcDailyPlan) ContrPcDailyPlan get_contr_pc_daily_plans Импортируются дневные планы (лимиты) по договорам и точкам подключения. Команда параметризованная. Может принимать от 1 до 3х аргументов.

Параметры могут задаваться в трех формах: Параметры отделяются от команды знаком подчеркивания ("_"), не пробел*!

  • Начало и окончание отделяются ".." также без пробелов.
  • Значения 3х параметров следующие:
    • Первый - начало интервала для которого загружаются планы.
    • Второй - окончание интервала.
  • Третий - ограничение заданного выше интервала указанным числом. Сделано прежде всего чтобы можно было делать относительные интервалы, ограниченные сверху. Например _30 дней с начала месяца,_ но не далее сегодняшнего числа
  • Указание второго параметра не обязательно, тогда он будет принят концом текущего дня.
  • Указание третьего параметра также не обязательно - тогда не будет этого ограничения.
  • Указываются только даты, без времени. Подразумевается 00:00:00 для начального дня, и 23:59:59 для конечного.
  • Для указания даты (начальной или конечной), применяются следующие правила:
    • Если это число (Пример -10, +5, 0, 10) то это количество дней от текущего. Причем отрицательные отсчитываются назад, положительные вперед. Знак + может быть опущен.
  • Если число начинается с латинского символа M в любом регистре, (например M-10, m10, M+10) - берется количество дней относительно начала текущего месяца*.
    • Если первым стоит символ #, то за ним должна стоять дата в формате yyyy.MM.dd - будет взята абсолютная дата.
  • Обратите внимание, интервал больше 15 дней строго не рекомендуется - может быть недостаточно памяти в 1С для формирования результата. На некоторых машинах этот интервал еще меньше, и например в Белгороде составляет около 5 дней всего (там 1С 32 бита)

Примеры:

  • Сейчас грузится текущий месяц с начала и до сегодняшнего числа, за три приема чтобы не создавать каждый раз чрезмерной нагрузки, что соответствует: ContrPcDailyPlan_M0..M10..0,ContrPcDailyPlan_M11..M20..0,ContrPcDailyPlan_M21..M31..0
  • Загрузка недели (7 дней) предшествующей сегодняшнему дню: ContrPcDailyPlan_-7
  • Загрузка недели (7 дней) вперед, от сегодняшнего дня: ContrPcDailyPlan_0..+7 или просто ContrPcDailyPlan_0..7
  • Загрузка +/- недели: ContrPcDailyPlan_-7..+7 или ContrPcDailyPlan_-7..7
  • Загрузка первой недели (7 дней) месяца: ContrPcDailyPlan_M0..M7
  • Загрузка целого месяца (31 день), но не далее текущего дня: ContrPcDailyPlan_M0..M31..0
  • Загрузка планов с 21 февраля 2012 года до текущего дня (включительно): ContrPcDailyPlan_#2012.02.21
  • Загрузка планов с 21 февраля 2012 года по 25 февраля: ContrPcDailyPlan_#2012.02.21..#2012.02.25
 С версии адаптера 14.9.2 планы, которых нету в АИС удаляются и из ИМУС.

(deprecated in С появления CcDailyPlan)С появления CcDailyPlan объявляется устаревшей и будет удалена из следующих версий. Удалена с версии 16.0.pre5 (RGC-1066)

CcDailyPlan get_cc_daily_plans Импортируются дневные планы (лимиты) по субъектам распределения (contract_connection) и площадкам. Команда параметризованная и приходит на смену ContrPcDailyPlan (см. выше).

Параметры точно такие же.

С версии 15pre8. ESB-492.

Исключает использование команды AttachPcToContract - могут появляться нежелательные объекты если выполняются вместе.

IndependentPlan get_independent_plans Импортируются планы (лимиты) независимой поставки минуя РГК подобно планам CcDailyPlan. Параметры точно такие же. (deprecated in 15.14.3)С версии 15.8. ESB-432. Удалена с версии 15.14.3 - ESB-602 и теперь такие планы загружаются совместно с обычными (сделано по причине необходимости удаления старых планов, таким образом новые должны за одну и ту же дату приходить все одновременно).
AttachPcToGco get_relation_point_connect_to_gco Осуществляется связка ТП и площадок.
AutoMapRegion нет Предпринимается попытка автоматически сопоставить Субъекты РФ
AutoMapIndustryGroup нет Предпринимается попытка автоматически сопоставить Группы Отраслей
AutoMapIndustry нет Предпринимается попытка автоматически сопоставить Отрасли
AutoMapEquipModel нет Предпринимается попытка автоматически сопоставить модели корректоров
AutoMapPriorityMark нет Предпринимается попытка автоматически сопоставить виды ценообразования
GetInfo get_info Выводится информация о запущенной версии адаптера ИМУС и Веб-сервиса на стороне ИУС-ГАЗ и некоторую другую полезную информацию
Report (или GetReport) нет Генерируется отчет о состоянии и посылается по почте.

Может принимать 2 параметра (разделяются символом "%", значения от имени параметра разделяются символом: "+"):

  • to - адрес получателя. Если не задан, берется сконфигурированный по умолчанию список из ais.ws.report.to.
  • file - список файлов (через "+") которые включить в архив отчета. Прежде всего для решения ШИВА. Имя файла "errors" имеет специальное значение - будут включены все файлы XML хранилища ошибок, которые не пустые.

Пример: amq-command ReportNEW_to=p.alexeev@spb.ant-inform.ru%file=errors+D:\IMUS\esb\imus-esb\log\ais.log

С версии адаптера 15.7 расширена параметрами и переименована из ReportNEW. ESB-416
GenGcoFromPcAndConsumer gen_gco_from_pc_and_consumer Производится генерация площадок из ТП и потребителя, если таковые не ведутся в АИС не может быть автоматически определено (см. врезку в конце)
AutoMapTelemetry get_relation_foreign_system Забираются (переносятся из ИУС-ГАЗ, если ведутся) связки каналов телеметрии с УУГ (только если на нем найден единственный канал) или каналами.

Обратите внимание, связывание на уровне площадок или потребителей не поддерживается, потому что не точно.

Данные импортируются из РегистрСведений.СинхронизацияССистемамиТелеметрии.СрезПоследних где установлен признак ВыполнятьСинхронизацию

(deprecated in 15.14.2) AutoRelateGasMetersToChannels get_relation_gas_meter_to_uug Производится попытка развесить измерительное оборудование по каналам (в АИС они на УУГ) Устарела с версии 15.0 (ESB-588) адаптера и сервиса.

Удалена с версии 15.0 и должна быть везде удалена.

Query debug Позволяет выполнить 1С запрос из файла md/query.sql в АИС. Результат пишется в md/query.result.xml
GenerateConsumptionDown нет Генерируется вся недостающая структура потребления вниз от площадки: узел, корректор, канал. По всем трем ступеням, вне зависимости на какой обрывается цепочка потомков. Операция безопасная - второй объект не создается никогда, если есть уже один или более. Сгенерированные объекты имеют в поле "Ид. В системе создателя" префикс "gen:" - оставшаяся часть копируется с родителя.
AttachPcToGcoGenerated нет Связывание сгенерированных командой #GenGcoFromPcAndConsumer площадок с ТП Может использоваться неявно из команды #AttachPcToGco через опцию ais.ws.attachPcToGcoConsists.
Exec нет Для - позволяет выполнить команду на сервере
SetCodeKDFofConsumerIntoGeneratedGCO debug Команда добавлена на запрос Курска добавить в комментарий сгенерированной площадки код КДФ. Вряд ли будет интересна кому-то еще. ESB-518. C версии адаптера 15.1.
DumpQ нет Параметризованная команда выгрузки актированных объемов.

На данный момент поддерживается параметры:

  • DumpQ_PcDay31d для дневных объемов
  • DumpQ_PcHour7d - для часовых
  • DumpQ_ContrDay31d - оперативные суточные объемы потребления в разрезе договоров (за 31 день)
  • DumpQ_ContrMonth2p - посуточные данные коммерческого месячного баланса в разрезе договоров и точек подключения (за текущий и предыдущий отчетные периоды – текущий и предыдущий месяцы)
RebuildZones нет Вызывает перестроение всех Зон ГазоПотребления (ГП) т.к. для ускорения и избавления ошибок они не перестраиваются автоматически во время загрузки. См. QUICK-1944, QUICK-1883, QUICK-1824

Команда не имеет аналога в меню внешних систем, вместо этого может быть вызвана в АРМе на панели "редактор" Зон

UpdateGcoMainContract нет Проставляет основной договор на площадку с максимальным сроком действия если не проставлен никакой. Чтобы проставить всем, можно передать параметр all
Обратите внимание, команда локальна - данные не берутся из АИС РГ. Т.к. площадка в общем-то может быть привязана к нескольким договорам (особенно учитывая дополнительные соглашения), для ИУС-ГАЗ это будет лишь некоей "суррогатной" сущностью, называемой основным договором, который будет показываться в формах и отчетах по умолчанию. Все договоры, вы всегда в состоянии посмотреть через привязку к Субъект распределениясубъектам распределения
С версии адаптера 14.4.3. QUICK-2076
ConsType get_cons_types Загрузка ИМУС ConsumerType - Категорий потребления. С версии адаптера 15pre7. ESB-504
AutoMapConsType нет Предпринимается попытка автоматически сопоставить Категории потребления С версии 15.1pre1. ESB-508
ExportQ write_q Экспортирует распределённые по субъектам распределения суточные объёмы в АИС РГ. Команда параметризованная. Параметры точно такие же как у CcDailyPlan. С версии 17.0.pre0. ESB-636.
Запись сначала должна быть включена явно!
Eval нет Команда общего назначения для просмотра состояний, свойств и изменения настроек адаптера в без перезапуска. Сам адаптер доступен в контексте как ths (не this!). Допустим любой валидный Groovy код.

Например:

  • "println ths.debug"
  • "ths.debug = true".
 С версии 17.0.pre4. ESB-732.
Источник — «http://ais-site.dgtserv.ru/wiki_/index.php?title=Команды_адаптера&oldid=472»