Назначение
Плагин db в hid предназначен для удаленной работы с ядром АСР "Гидра". Он позволяет выполнять хранимые процедуры и делать SQL-выборки из БД без установки непосредственного соединения с ней.
Принцип работы
Для работы с hid используется протокол XML-RPC или SOAP.
Все хранимые процедуры СУБД отображаются в названия методов напрямую (например, для процедуры SI_USERS_PKG.SI_USERS_PUT используется соответствующий метод плагина SI_USERS_PKG.SI_USERS_PUT). В качестве аргумента методов хранимых процедур следует передавать структуру (хэш, словарь) с параметрами ее вызова. Методы хранимых процедур возвращают структуры переданных параметров, но с измененными во время выполнения значениями (например, если передавать в процедуру SI_USERS_PKG.SI_USERS_PUT в качестве значения num_N_USER_ID NULL, то на "выходе" процедуры в качестве значения num_N_USER_ID будет идентификатор созданного абонента).
...
Метод SELECT возвращает структуру (хэш, словарь) следущего содержания:
| Code Block |
|---|
{
'RecordsNumber' => RecordsNumber,
'PagesNumber' => PagesNumber,
'SelectResult' => SelectResult,
}
|
RecordsNumber — количество записей результата выборки;PagesNumber — количество страниц результата выборки;SelectResult — список (массив) записей. Каждая запись представляется еще одним списком, элементы которого соответствуют выбираемым полям таблицы. Все числовые поля таблиц из БД представляются в виде строк.
Параметры конфига hid
db select page size — размер страницы выборки. По умолчанию — 20.db allow unlimited select — флаг разрешения выборок без ограничения (on или off). По умолчанию — off.
Примеры
Физические лица
...
Получение информации о юридическом лице
| Code Block |
|---|
SELECT("SELECT * FROM SI_V_PERSONSCOMPANIES_JR WHERE N_COMPANY_ID = <num_N_COMPANY_ID>")
|
Получение информации о физическом лице
...
num_N_COMPANY_ID — идентификатор юр. лица
Удаление физического лица
| Code Block |
|---|
SI_PERSONS_PKG.SI_PERSONS_DEL({
'num_N_PERSON_ID' => <numnum_N_PERSON_ID>"ID,
})
|
num_N_PERSON_ID — идентификатор физ. лица.
...
Добавление/изменение физического лица
| Code Block |
|---|
SI_PERSONS_PKG.SI_PERSONS_PUT({
'num_N_PERSON_ID' => num_N_PERSON_ID,
'vch_VC_SURNAME' => 'Шварценгольд',
'vch_VC_SECOND_NAME' => 'Викторович',
'ch_C_SEX' => 'M',
'num_N_SUBJ_GROUP_ID' => 49001,
'vch_VC_INN' => '1234567891',
'num_N_DOC_AUTH_TYPE_ID' => 2015,
'vch_VC_DOC_SERIAL' => '01 06',
'vch_VC_DOC_NO' => '489635',
'dt_D_DOC' => DATE('24.01.2009', 'DD.MM.YYYY'),
'vch_VC_DOCUMENT' => 'Отделением по району Царицыно ОУФМС России по г. Москве в ЮАО',
'dt_D_BIRTH' => DATE('20.03.1955', 'DD.MM.YYYY'),
'vch_VC_BIRTH_PLACE' => 'г. Москва',
'num_N_SUBJ_STATE_ID' => 2011,
'num_N_CITIZENSHIP_ID' => 21101,
})
|
num_N_PERSON_ID — идентификатор физ. лица. Если равен NULL — производится создание, иначе — редактированиеnum_N_SUBJ_GROUP_ID — идентификатор группы физ. лиц (представление SI_V_SUBJ_GROUPS)num_N_DOC_AUTH_TYPE_ID — идентификатор типа документа, удостоверяющего личность (справочник REF_TYPE_Document)num_N_SUBJ_STATE_ID — идентификатор состояния СУ (справочник REF_TYPE_Subject_State, SYS_CONTEXT('CONST', 'SUBJ_STATE_On') == 2011)num_N_CITIZENSHIP_ID — идентификатор региона гражданства
Удаление физического лица
| Code Block |
|---|
SI_PERSONS_PKG.SI_PERSONS_DEL({
'num_N_PERSON_ID' => num_N_PERSON_ID,
})
|
num_N_PERSON_ID — идентификатор физ. лица.
Юридические лица
Получение списка юридических лиц
| Code Block |
|---|
SELECT("SELECT * FROM SI_V_COMPANIES_JR")
|
Получение информации о юридическом лице
...
Ознакомиться со многими другими примерами работы с БД вы можете в разделе «Примеры работы с БД (Офис оператора связи)». Для использования этих примеров в работе с плагином db агента hid вам достаточно привести код PL/SQL к формату, описанному в примерах выше.
XML-запросы
Можно выполнять запросы к HID, используя XML-RPC:
| Code Block |
|---|
|
curl -d '<?xml version="1.0"?><methodCall><methodName>SELECT</methodName><params><param><value><string>SELECT * FROM SI_V_COMPANIES_JRUSERS WHERE N_COMPANYSUBJECT_ID = <num_N_COMPANY_ID>")
|
num_N_COMPANY_ID — идентификатор юр. лица.
Редактирование (создание) юридического лица
| Code Block |
|---|
SI_COMPANIES_PKG.SI_COMPANIES_PUT({
'num_N_COMPANY_ID' => num_N_COMPANY_ID,
'num_N_OPF_ID' => 1041,
'num_N_REGION_ID' => 21301,
'vch_VC_CODE'302</string></value></param></params></methodCall>' 'http://hydra:pass@127.0.0.1:10080/xml-rpc/db' |
| Code Block |
|---|
| language | yml |
|---|
| title | результат |
|---|
| collapse | true |
|---|
|
<?xml version='1.0'?>
<methodResponse>
<params>
<param>
<value>
=> 'Вектор', 'vch_VC_INN'<struct>
=> '1234567891', 'vch_VC_OGRN' <member>
=> '12345', 'num_N_SUBJ_STATE_ID' => 2011, 'num_N_SUBJ_GROUP_ID' => 196401,
})
|
num_N_COMPANY_ID — идентификатор юр. лица. Если равен NULL — производится создание, иначе — редактированиеnum_N_OPF_ID — идентификатор ОПФ (справочник REF_TYPE_OPF)num_N_REGION_ID — идентификатор регионаnum_N_SUBJ_STATE_ID — идентификатор состояния СУ (справочник REF_TYPE_Subject_State, SYS_CONTEXT('CONST', 'SUBJ_STATE_On') == 2011)num_N_SUBJ_GROUP_ID — идентификатор группы юр. лиц (представление SI_V_SUBJ_GROUPS)
Удаление юридического лица
| Code Block |
|---|
SI_COMPANIES_PKG.SI_COMPANIES_DEL({
'num_N_COMPANY_ID' => num_N_COMPANY_ID,
})
|
num_N_COMPANY_ID — идентификатор юр. лица.
Абоненты
Получение списка абонентов
| Code Block |
|---|
SELECT("SELECT * FROM SI_V_USERS_JR")
|
Получение информации об абоненте
| Code Block |
|---|
SELECT("SELECT * FROM SI_V_USERS_JR WHERE N_SUBJECT_ID = <num_N_SUBJECT_ID>")
|
num_N_SUBJECT_ID — идентификатор абонента
Редактирование (создание) абонента
| Code Block |
|---|
SI_USERS_PKG.SI_USERS_PUT({
'num_N_USER_ID' <name>RecordsNumber</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>PagesNumber</name>
<value>
<string>1</string>
</value>
</member>
<member>
<name>SelectResult</name>
<value>
<array>
<data>
<value>
<array>
<data>
<value>
<string>1</string>
</value>
<value>
<string>302</string>
</value>
<value>
<string>302</string>
</value>
<value>
<string>2001</string>
</value>
<value>
<string>301</string>
</value>
<value>
<string>Миграторов Мигратор1 Миграторович1</string>
</value>
<value>
<string>18001</string>
</value>
<value>
<nil/>
</value>
<value>
<string>5011</string>
</value>
<value>
<nil/>
</value>
<value>
<string>Миграторов М. М.</string>
=> num_N_USER_ID, 'num_N_BASE_SUBJECT_ID' => 712282701, 'num_N_SUBJ_GROUP_ID' => 255664501, 'vch_VC_CODE' </value>
=> 'uralsky', 'num_N_SUBJ_STATE_ID' => 2011, })
|
num_N_USER_ID — идентификатор абонента. Если равен NULL — производится создание, иначе — редактированиеnum_N_BASE_SUBJECT_ID — идентификатор физ. или юр. лица, к которому добавляется абонентnum_N_SUBJ_GROUP_ID — идентификатор группы абонентов (представление SI_V_SUBJ_GROUPS)num_N_SUBJ_STATE_ID — идентификатор состояния СУ (справочник REF_TYPE_Subject_State, SYS_CONTEXT('CONST', 'SUBJ_STATE_On') == 2011)
Удаление абонента
| Code Block |
|---|
SI_USERS_PKG.SI_USERS_DEL({
'num_N_USER_ID' => num_N_USER_ID,
})
|
num_N_USER_ID — идентификатор абонента
Договоры
Получение информации о договорах
| Code Block |
|---|
SELECT("SELECT * FROM SI_V_USER_CONTRACTS")
|
Получение информации о договоре
| Code Block |
|---|
SELECT("SELECT * FROM SI_V_USER_CONTRACTS WHERE N_DOC_ID = <num_N_DOC_ID>")
|
num_N_DOC_ID — идентификатор договора
Добавление договора с абонентом
| Code Block |
|---|
SI_USERS_PKG.CREATE_CONTRACT({
'num_N_USER_ID' <value>
<string>Migrator</string>
</value>
<value>
<string>Миграторов М. М.</string>
=> 49979801, 'num_N_BASE_CONTRACT_ID' => 40174101, 'num_N_CONTRACT_ID' </value>
=> NULL, }) |
num_N_USER_ID — идентификатор абонентаnum_N_BASE_CONTRACT_ID — идентификатор базового договора (представление SD_V_DOCUMENTS_JR)num_N_CONTRACT_ID — идентификатор созданного договора
Редактирование договора
| Code Block |
|---|
SD_CONTRACTS_PKG.SD_CONTRACTS_PUT({ 'num_N_DOC_ID' => 52481301, 'num_N_DOC_TYPE_ID' => 1002, 'dt_D_DOC' => DATE('11.06.2010', 'DD.MM.YYYY'),
'vch_VC_DOC_NO' => 'T0100001',
'vch_VC_REM' => 'Тестовый',
'dt_D_BEGIN' => DATE('11.06.2010', 'DD.MM.YYYY'),
'dt_D_END' <value>
<string>Migrator</string>
</value>
<value>
<string>MIGRATOR</string>
</value>
<value>
<string>МИГРАТОРОВ М. М.</string>
</value>
<value>
<nil/>
</value>
<value>
<nil/>
</value>
<value>
<dateTime.iso8601>20090617T17:18:39</dateTime.iso8601>
=> NULL, }) |
num_N_DOC_TYPE_ID — идентификатор типа договора (справочник REF_TYPE_Document_Type, договор на оказание услуг — SYS_CONTEXT('CONST', 'DOC_TYPE_SubscriberContract') == 1002)
Удаление договора
| Code Block |
|---|
SD_DOCUMENTS_PKG.SD_DOCUMENTS_DEL({ 'num_N_DOC_ID' => num_N_DOC_ID, }) |
num_N_DOC_ID — идентификатор договора с абонентом
Редактирование (создание) подписки на услуги
| Code Block |
|---|
SI_USERS_PKG.SI_USER_GOODS_PUT({ 'num_N_SUBJ_GOOD_ID' => num_N_SUBJ_GOOD_ID, 'num_N_GOOD_ID' => 22165301,</value>
'num_N_SUBJ_GOOD_TYPE_ID' => 1031, 'num_N_SUBJECT_ID' => 712282901, 'num_N_ACCOUNT_ID' => 712283801, 'num_N_OBJECT_ID' => 712284401, 'num_N_PAY_DAY' <value>
=> 1, 'num_N_LINE_NO' => 1000000, 'num_N_QUANT' = <nil/>
1, 'num_N_UNIT_ID' => 1009, 'num_N_DOC_ID' => 712283101, 'num_N_PAR_SUBJ_GOOD_ID' => NULL,
'dt_D_BEGIN' </value>
<value>
<array>
<data>
<value>
<string>системный_пользователь</string>
=> DATE('11.06.2010', 'DD.MM.YYYY'),
'dt_D_END' </value>
<value>
<string>не_выгружать_пл</string>
=> NULL, })
|
num_N_SUBJ_GOOD_ID — идентификатор подписки на услуги. Если равен NULL — производится создание, иначе — редактированиеnum_N_GOOD_ID — идентификатор тарифного плана или услуги из номенклатуры (представление SR_V_GOODS)num_N_SUBJ_GOOD_TYPE_ID — идентификатор типа подписки (справочник REF_TYPE_Subj_Good_Type, тарифный план — SYS_CONTEXT('CONST', 'GOOD_SUBJ_Tariff') == 1031, услуга — SYS_CONTEXT('CONST', 'GOOD_SUBJ_Periodic') == 2031)num_N_SUBJECT_ID — идентификатор абонентаnum_N_ACCOUNT_ID — идентификатор лицевого счетаnum_N_OBJECT_ID — идентификатор оборудованияnum_N_PAY_DAY — расчетный день месяцаnum_N_LINE_NO — номер строки по порядку при отображении таблицы. Для первой родительской записи — 1000000, для второй родительской — 2000000 и т.д. Для первой дочерней записи первой родительской записи — 1000001, для второй дочерней записи третьей родительской строки — 3000002.num_N_QUANT — количествоnum_N_UNIT_ID — идентификатор единицы измерения (представление SI_V_UNITS, неопределенно — SYS_CONTEXT('CONST', 'UNIT_Piece') == 2009)num_N_DOC_ID — идентификатор договораnum_N_PAR_SUBJ_GOOD_ID — идентификатор родительской подписки (указывается в случае, если добавляется дочерняя строка)
Удаление подписки на услуги
| Code Block |
|---|
SI_USERS_PKG.SI_USER_GOODS_PUT({
'num_N_SUBJ_GOOD_ID' => num_N_SUBJ_GOOD_ID,
})
|
num_N_SUBJ_GOOD_ID — идентификатор подписки на услуги
Лицевые счета
Добавление лицевого счета для абонента
| Code Block |
|---|
SI_USERS_PKG.CREATE_ACCOUNT({
'num_N_USER_ID' => 49979801,
'num_N_ACCOUNT_ID' => NULL,
})
|
num_N_USER_ID — идентификатор абонентаnum_N_ACCOUNT_ID — идентификатор созданного лицевого счета
Редактирование (добавление) счета
| Code Block |
|---|
SI_SUBJECTS_PKG.SI_SUBJ_ACCOUNTS_PUT({
'num_N_ACCOUNT_ID' => num_N_ACCOUNT_ID,
'num_N_SUBJECT_ID' => 52480701,
'num_N_ACCOUNT_TYPE_ID' => 2042,
'num_N_BANK_ID' </value>
</data>
</array>
</value>
<value>
<string>системный_пользователь, не_выгружать_пл</string>
</value>
<value>
<string>Создан при инсталляции</string>
</value>
=> 100, 'num_N_CURRENCY_ID' => 1044, 'vch_VC_ACCOUNT' => 'T0100001',
'num_N_OVERDRAFT' => 100,
'dt_D_OVERDRAFT_END' => DATE('15.06.2010', 'DD.MM.YYYY'),
})
|
num_N_ACCOUNT_ID — идентификатор счета. Если равен NULL — производится создание, иначе — редактированиеnum_N_SUBJECT_ID — идентификатор СУ (абонента)num_N_ACCOUNT_TYPE_ID — идентификатор типа счета (справочник REF_TYPE_Account_Type, лицевой счет — SYS_CONTEXT('CONST', 'ACC_TYPE_Personal') == 2042)num_N_BANK_ID — идентификатор банка (для реальных счетов) или оператора связи (для лицевых)num_N_CURRENCY_ID — идентификатор валюты (справочник REF_TYPE_Currency, лицевой счет — SYS_CONTEXT('CONST', 'CURR_Ruble') == 1044)vch_VC_ACCOUNT — номер счетаnum_N_OVERDRAFT — кредитный лимитdt_D_OVERDRAFT_END — дата окончания срока действия кредитного лимита
Удаление счета
| Code Block |
|---|
SI_SUBJECTS_PKG.SI_SUBJ_ACCOUNTS_DEL({
num_N_ACCOUNT_ID => 52481101,
})
|
num_N_ACCOUNT_ID — идентификатор счета
<value>
<string>100</string>
</value>
<value>
<nil/>
</value>
<value>
<nil/>
</value>
<value>
<nil/>
</value>
<value>
<string>50853901</string>
</value>
<value>
<array>
<data>
<value>
<int>50853901</int>
</value>
</data>
</array>
</value>
<value>
<string>Системные пользователи</string>
</value>
<value>
<string>51845401</string>
</value>
<value>
<dateTime.iso8601>20250521T11:12:34</dateTime.iso8601>
</value>
<value>
<string>4624499330801</string>
</value>
</data>
</array>
</value>
</data>
</array>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse> |