Команды адаптера
Команды адаптеру и принцип работы
За каждую операцию выполняется только одно действие, обычно это загрузка одного вида объектов (например площадок) или какая-либо генерация.
Посылать команды можно 3мя способами:
- Через очереди ActiveMQ из браузера, в очередь AIS.CMDCONF.IN (по умолчанию адрес http://localhost:8161/)
- Большинство команд (об исключениях будет написано дополнительно) могут быть также посланы через АРМ.
- С использованием консольной утилиты 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 | Импортируются канал. При загрузке каналов статус проставляется по родителю. Каскадное обновление статусов. | С версии адаптера 2.22.0.22. ASDU-2598 | Команды -> Команды учётных систем -> Загрузка оборудования -> Загрузить Каналы | ||||
GasConsEquipClass |
get_gas_cons_equip_classes | Импортируются классы ГПО | Команды -> Команды учётных систем -> Загрузка оборудования -> Загрузить Классы ГПО | |||||
GasConsEquipType |
get_gas_cons_equip_types | Импортируются Типы ГПО | Команды -> Команды учётных систем -> Загрузка оборудования -> Загрузить Типы ГПО | |||||
GasConsEquip |
get_gas_cons_equips | Импортируется ГПО | Команды -> Команды учётных систем -> Загрузка оборудования -> Загрузить Газопотребляющее оборудование (ГПО) | |||||
Pdz |
get_pdz | Импортируется ПДЗ. При загрузке из АИС могут обновляться уже созданные в ИМУС ПДЗ без смены системы создателя. Задаваемые параметры (указаны значения по умолчанию):
1. долг контрагента более
2. вид реализации
|
С версии 22. ASDU-2768 | Команды -> Команды учётных систем -> Загрузка договоров и планов -> ПДЗ QUICK-13546 | ||||
GasMeterType |
get_gas_meter_types | Импортируются типы измерительного оборудования. | Из-за нашей схемы, импорт ограничен только в модели ИО, не в конечные устройства, как это может быть в АИС. Данный вопрос на рассмотрении у аналитиков в задаче ESB-643. | Команды -> Команды учётных систем -> Загрузка оборудования -> Загрузить Типы измерителей | ||||
GasMeterModel |
get_gas_meter_models | Импортируются модели измерительного оборудования | Команды -> Команды учётных систем -> Загрузка оборудования -> Загрузить Модели измерителей | |||||
GasMeter |
get_gas_meters | Импортируется измерительное оборудование | Команды -> Команды учётных систем -> Загрузка оборудования -> Загрузить Измерители | |||||
PriorityMark |
get_priority_marks | Импортируются типы ценообразования | Ранее, до версии 15 были виды договоров | Команды -> Команды учётных систем -> Загрузка договоров и планов -> Загрузить Типы ценообразования | ||||
Contract |
get_contracts | Импортируются договоры | Команды -> Команды учётных систем -> Загрузка договоров и планов -> Загрузить Договоры | |||||
LpuDic |
get_lpus | Загружается информация о принадлежности ГРС к ЛПУ из 1С | ||||||
PurContract |
get_pur_contracts | Импортируются договоры закупки газа | С версии сервиса 18.4.pre22 и адаптера 18.4.pre65. ESB-1385 | Пункт меню запланирован - QUICK-6371 | ||||
PurchaseContract |
get_purchase_contracts | Импортируется закупка (поставка) газа | С версии сервиса и адаптера 15pre5. ESB-502. С версии сервиса 18.4.pre22 и адаптера 18.4.pre65 переименовано в Закупку, до этого было договор закупки . ESB-1385 | Команды -> Команды учётных систем -> Загрузка договоров и планов -> Загрузить Договоры закупки. Изменение именования пункта запланировано - QUICK-6371 | ||||
TransDic |
get_trans_dics | Импортируются подразделения ТрансГазов | Создаются только ПМ.
требуется маппинг. Импортируются по новой схеме, в таблицу imus_mapping. С версии 15.0 |
Команды -> Команды учётных систем -> Загрузка справочников -> Загрузить Трансгазы | ||||
GasProducer |
get_gas_producers | Импортируются производители газа. | Создаются только ПМ, требуется маппинг. Импортируются по новой схеме, в таблицу imus_mapping. С версии 15.0 | Команды -> Команды учётных систем -> Загрузка справочников -> Загрузить Производителей газа | ||||
AutoMapGasProducer |
нет | Предпринимается попытка автоматически сопоставить Производителей Газа | С версии 15.1pre1. ESB-508 | нет | ||||
GasSupplier |
get_gas_suppliers | Импортируются Поставщики газа | Создаются только ПМ.требуется маппинг. Импортируются по новой схеме, в таблицу imus_mapping. С версии 15.0 | Команды -> Команды учётных систем -> Загрузка справочников -> Загрузить Поставщиков газа | ||||
AutoMapGasSupplier |
нет | Предпринимается попытка автоматически сопоставить Поставщиков Газа | С версии 15.1pre1. ESB-508 | Нет | ||||
GasVendor |
get_gas_vendors | Импортируются продавцы (владельцы) газа | Создаются только ПМ, требуется маппинг. Импортируются по новой схеме, в таблицу imus_mapping. С версии 15pre6 | Команды -> Команды учётных систем -> Загрузка справочников -> Загрузить Продавцов газа | ||||
AutoMapGasVendor |
нет | Предпринимается попытка автоматически сопоставить Продавцов Газа | С версии 15.1pre1. ESB-508 | Нет | ||||
AutoMapTransDic |
нет | Предпринимается попытка автоматически сопоставить отделений Трансгаза | С версии адаптера 15.11.1. ESB-565 | Нет | ||||
AttachPcToContract
(deprecated in С появления CcDailyPlan) |
get_relation_point_connect_to_contract | Осуществляется связка договоров с ТП | С момента появления CcDailyPlan объявляется устаревшей и будет удалена из следующих версий. Удалена с версии 16.0.pre5 (RGC-1066) в адаптере и 18.4.pre5 сервиса (ESB-1040). | Удалена | ||||
(deprecated in С появления CcDailyPlan) |
|
Импортируются дневные планы (лимиты) по договорам и точкам подключения. Команда параметризованная. Может принимать от 1 до 3-х аргументов. | С версии адаптера 14.9.2 планы, которых нету в АИС удаляются и из ИМУС.
(deprecated in С появления CcDailyPlan)С появления CcDailyPlan объявляется устаревшей. Удалена с версии 16.0.pre5 (RGC-1066) адаптер и версии 18.4.pre5 сервиса - ESB-991 |
Удалена | ||||
CcDailyPlan | get_cc_daily_plans | Импортируются дневные планы (лимиты) по субъектам распределения (contract_connection) и площадкам. Команда параметризованная и приходит на смену ContrPcDailyPlan.
Может принимать от 1 до 3х аргументов. Параметры могут задаваться в трех формах: Параметры отделяются от команды знаком подчеркивания ("_"), не пробел*!
Примеры:
|
С версии 15pre8. ESB-492.
Исключает использование команды AttachPcToContract - могут появляться нежелательные объекты если выполняются вместе. До версии адаптера 18.26 не было различия между m и M (ESB-915). |
Команды -> Команды учётных систем -> Загрузка договоров и планов -> Загрузить Планы | ||||
(deprecated in 15.14.3) |
|
Импортируются планы (лимиты) независимой поставки минуя РГК подобно планам CcDailyPlan. Параметры точно такие же. | (deprecated in 15.14.3)С версии 15.8. ESB-432. Удалена с версии 15.14.3 - ESB-602 в адаптере и версии 18.4.pre5 сервиса - ESB-991. Теперь такие планы загружаются совместно с обычными (сделано по причине необходимости удаления старых планов, таким образом новые должны за одну и ту же дату приходить все одновременно). | Нет | ||||
AttachPcToGco |
get_relation_point_connect_to_gco | Осуществляется связка ТП и площадок. | Команды -> Команды учётных систем -> Загрузка объектов -> Загрузить Привязку ТП к Площадкам и каналам | |||||
AutoMapRegion |
нет | Предпринимается попытка автоматически сопоставить Субъекты РФ | Нет | |||||
AutoMapIndustryGroup |
нет | Предпринимается попытка автоматически сопоставить Группы Отраслей | Нет | |||||
AutoMapIndustry |
нет | Предпринимается попытка автоматически сопоставить Отрасли | Нет | |||||
AutoMapEquipModel |
нет | Предпринимается попытка автоматически сопоставить модели корректоров | Нет | |||||
AutoMapPriorityMark |
нет | Предпринимается попытка автоматически сопоставить виды ценообразования | Нет | |||||
GetInfo |
get_info | Выводится информация о запущенной версии адаптера ИМУС и Веб-сервиса на стороне ИУС-ГАЗ и некоторую другую полезную информацию | Команды -> Команды учётных систем -> Дополнительно -> Информация | |||||
Report (или GetReport) | нет | Генерируется отчет о состоянии и посылается по почте.
Может принимать 2 параметра (разделяются символом "%", значения от имени параметра разделяются символом: "+"):
Пример: amq-command Report_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 | Производится генерация площадок из ТП и потребителя, если таковые не ведутся в АИС. Т.к. таких объектов нет в АИС статус объектов всегда "В эксплуатации" | не может быть автоматически определено (см. врезку в конце)
Может генерироватья только из подключения, если установлена опция ais.ws.genGCOonlyByPC |
Команды -> Команды учётных систем -> Загрузка объектов -> Сгенерировать Площадки из подключений (и Потребителя) | ||||
AutoImusMapTelemetry ( |
get_relation_foreign_system | Забираются (переносятся из ИУС-ГАЗ, если ведутся) связки каналов телеметрии с УУГ (только если на нем найден единственный нескрытый канал) или каналами.
Обратите внимание, связывание на уровне площадок или потребителей не поддерживается, потому что не точно. Данные импортируются из РегистрСведений.СинхронизацияССистемамиТелеметрии.СрезПоследних где установлен признак ВыполнятьСинхронизацию Команда внешних систем в АРМе появилась с версии 1.5.70 (17.0 сервис). |
Команды -> Команды учётных систем -> Загрузка оборудования -> Загрузить привязку телеметрии | |||||
AutoRelateGasMetersToChannels
(deprecated in 15.14.2) |
get_relation_gas_meter_to_uug | Производится попытка развесить измерительное оборудование по каналам (в АИС они на УУГ) | Устарела с версии 15.0 (ESB-588) адаптера и сервиса.
Удалена с версии 15.0 адаптера и 18.4.pre5 сервиса (ESB-1040). |
Удалена | ||||
Query |
debug | Позволяет выполнить 1С запрос из файла md/query.sql в АИС. Результат пишется в md/query.result.xml | Нет | |||||
GenerateConsumptionDown новая команда DomainGenerateConsumptionDown |
нет | Генерируется вся недостающая структура потребления вниз от площадки: узел, корректор, канал. По всем трем ступеням, вне зависимости на какой обрывается цепочка потомков. Операция безопасная - второй объект не создается никогда, если есть уже один или более. Сгенерированные объекты имеют в поле "Ид. В системе создателя" префикс "gen:" - оставшаяся часть копируется с родителя.
Функционал отличается от генерации структуры вниз, которая выполняется в АРМ ИМУС |
Нет. Вместо этого есть генерация в соответствующих объектах. | |||||
AttachPcToGcoGenerated |
нет | Связывание сгенерированных командой #GenGcoFromPcAndConsumer площадок с ТП | Может использоваться неявно из команды #AttachPcToGco через опцию ais.ws.attachPcToGcoConsists | Нет | ||||
Exec |
нет | Для - позволяет выполнить команду на сервере | Нет | |||||
SetCodeKDFofConsumerIntoGeneratedGCO |
debug | Команда добавлена на запрос Курска добавить в комментарий сгенерированной площадки код КДФ. Вряд ли будет интересна кому-то еще. | ESB-518. С версии адаптера 15.1. | Нет | ||||
DumpQ |
нет | Параметризованная команда выгрузки актированных объемов.
На данный момент поддерживается параметры:
Команды параметризованы. Параметры точно такие же как у CcDailyPlan. |
Команды -> Команды учётных систем -> Экспорт данных -> {Часовые - утверждённый баланс, Суточные - утверждённый баланс, Суточные - утверждённое месячное распределение, Месячные - утверждённое месячное распределение} | |||||
RebuildZones |
нет | Вызывает перестроение всех Зон ГазоПотребления (ГП) т.к. для ускорения и избавления ошибок они не перестраиваются автоматически во время загрузки. | См. QUICK-1944, QUICK-1883, QUICK-1824 | Нет. Вместо этого может быть вызвана в АРМе на панели "редактор" Зон. | ||||
UpdateGcoMainContract |
нет | Проставляет основной договор на площадку с максимальным сроком действия если не проставлен никакой. Если параметр all не указан, то будет проставлен основной договор только для тех площадок, где он не задан. Если параметр all указан, то основной договор будет актуализирован для всех площадок.
Алгоритм по "простановке" договора работает следующим образом: 1. Для площадки вычисляется связь с ТП 2. На момент отработки команды во время ночной синхронизации (или принудительного запуска команды из АРМ) алгоритм подбирает все актуальные СР с этой ТП и определяет из них договоры. 3. Из найденных договоров выбирает один с максимальной датой окончания и пустой датой расторжения.
|
С версии адаптера 14.4.3. QUICK-2076
Пункт меню появится видимо с версии АРМ 1.5.80 (QUICK-2076) |
Команды -> Команды учётных систем -> Загрузка договоров и планов -> Проставить площадку на основной договор | ||||
ConsumerType |
get_cons_types | Загрузка ИМУС ConsumerType - Категорий потребления. | С версии адаптера 15pre7. ESB-504 | Команды -> Команды учётных систем -> Загрузка справочников -> Загрузить Категории потребления | ||||
AutoMapConsType |
нет | Предпринимается попытка автоматически сопоставить Категории потребления | С версии 15.1pre1. ESB-508 | Нет | ||||
ExportQ | write_q | Экспортирует распределённые по субъектам распределения суточные объёмы в АИС РГ. Команда параметризованная. Параметры точно такие же как у CcDailyPlan. | С версии 17.0.pre0. ESB-636.
|
Команды -> Команды учётных систем -> Экспорт данных (Веб-сервис) -> Суточные данные распределения (Веб-сервис)
QUICK-4198. С версии АРМ ~1.5.449 | ||||
ExportQMonth | write_q | Экспортирует распределённые суточные объёмы месячного распределения в АИС РГ. Команда параметризованная.
Параметры отделяются от команды знаком подчеркивания ("_"), не пробел*! Добавлен новый формат команды для запуска по расписанию - z и * - для вычисления месяца:
Примеры:
|
С версии 19.5.pre1 ESB-1597.
|
В АРМ присутствует выгрузка через Зоны ГП. Планируется - QUICK-8295. | ||||
ExportQRaw | write_q_raw | Экспортирует зону актирования по суткам (не распределённые по субъектам распределения суточные объёмы) в АИС РГ (в противовес ExportQ). Команда параметризованная. Параметры точно такие же как у CcDailyPlan.
|
С версии 18.2. ESB-876.
|
Команды -> Команды учётных систем -> Экспорт данных (Веб-сервис) -> Суточные данные актирования (Веб-сервис)
QUICK-4198. С версии АРМ ~1.5.449 | ||||
ExportQRawMonth | write_q_raw | Экспортирует зону актирования объёмы месячного потребления в АИС РГ. Команда параметризованная.
Параметры отделяются от команды знаком подчеркивания ("_"), не пробел*! Добавлен новый формат команды для запуска по расписанию - z и * - для вычисления месяца:
Примеры:
|
С версии 23. ASDU-3386.
|
|||||
ExportQRawTelezone | write_q_raw | Экспортирует суточные объёмы зоны КИО (телеметрии) в АИС РГ (в противовес ExportQ). Команда параметризованная. Параметры точно такие же как у CcDailyPlan.
Для загрузки определенного представления, необходимо в конце команды указывать идентификатор системы телеметрии. Например: ExportQRawTelezone_m0..M0_50.
|
С версии 19.1. ESB-1653.
|
Пока нет | ||||
Eval | нет | Команда общего назначения для просмотра состояний, свойств и изменения настроек адаптера в без перезапуска. Сам адаптер доступен в контексте как ths (не this!). Допустим любой валидный Groovy код.
Например:
|
С версии 17.0.pre4. ESB-732.
С версии 18.4.pre14 (ESB-1155) ths предоставляется для обратной совместимости, но совершенно не требуется, потому что выполняется в контсектсе адаптера и напрямую доступны все свойства и методы. Также добавлен доступ к глобальному объекту Config и вывод ошибки выполнения. |
Нет | ||||
Full | прямой нет | Мета-команда "Загрузить всё". Точно также как проходит стандартная загрузка ночью. Выполняются в одном пакете команды из ais.tasks ASDU-2925 | С адаптера 18.4.pre15. ESB-1180. | Команды -> Команды учётных систем -> Выполнить полную загрузку QUICK-5646 | ||||
GasType | get_gas_types | Загружаются виды газа в ПМ из планов, используемых в текущем году на дату загрузки. | С адаптера 18.4.pre26 и сервиса 18.4.pre15. ESB-1233. | Команды -> Команды учётных систем -> Загрузка договоров и планов -> Виды газа. | ||||
PriceVariant | get_price_variants | Загружаются признаки цены в ПМ | С адаптера версии 19.7. ESB-2602. | Пока нет | ||||
OkkCons | get_okk_cons | Загружается признак ТСО для Потребителей. | С адаптера 23. ASDU-2101. | Пока нет | ||||
OkkContract | get_okk_contract | Загружается признак ТСО для Договоров. | С адаптера 23. ASDU-2101. | Пока нет |