Назначение

Плагин 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(query, page_num), где query — SQL-запрос данных из БД, page_num — номер страницы результата (по умолчанию — 1). Для снижения нагрузки на БД выборки делаются постранично, т.е. весь результат запроса разбивается на страницы определенного размера (размер задается в конфиге hid). Если в качестве page_num передан 0, делается выборка без разбиения на страницы (при условии, что это разрешено в конфиге hid).

Метод SELECT возвращает структуру (хэш, словарь) следущего содержания:

{
  'RecordsNumber' => RecordsNumber,
  'PagesNumber'   => PagesNumber,
  'SelectResult'  => SelectResult,
}

Параметры конфига hid

Примеры

Физические лица

Получение списка физических лиц

SELECT("SELECT * FROM SI_V_PERSONS_JR")

Получение информации о физическом лице

SELECT("SELECT * FROM SI_V_PERSONS_JR WHERE N_PERSON_ID = <num_N_PERSON_ID>")

Редактирование (создание) физического лица

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,
})

Удаление физического лица

SI_PERSONS_PKG.SI_PERSONS_DEL({
  'num_N_PERSON_ID' => num_N_PERSON_ID,
})

Юридические лица

Получение списка юридических лиц

SELECT("SELECT * FROM SI_V_COMPANIES_JR")

Получение информации о юридическом лице

SELECT("SELECT * FROM SI_V_COMPANIES_JR WHERE N_COMPANY_ID = <num_N_COMPANY_ID>")

Редактирование (создание) юридического лица

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'         => 'Вектор',
  'vch_VC_INN'          => '1234567891',
  'vch_VC_OGRN'         => '12345',
  'num_N_SUBJ_STATE_ID' => 2011,
  'num_N_SUBJ_GROUP_ID' => 196401,
})

Удаление юридического лица

SI_COMPANIES_PKG.SI_COMPANIES_DEL({
  'num_N_COMPANY_ID' => num_N_COMPANY_ID,
})

Абоненты

Получение списка абонентов

SELECT("SELECT * FROM SI_V_USERS_JR")

Получение информации об абоненте

SELECT("SELECT * FROM SI_V_USERS_JR WHERE N_SUBJECT_ID = <num_N_SUBJECT_ID>")

Редактирование (создание) абонента

SI_USERS_PKG.SI_USERS_PUT({
  'num_N_USER_ID'         => num_N_USER_ID,
  'num_N_BASE_SUBJECT_ID' => 712282701,
  'num_N_SUBJ_GROUP_ID'   => 255664501,
  'vch_VC_CODE'           => 'uralsky',
  'num_N_SUBJ_STATE_ID'   => 2011,
})

Удаление абонента

SI_USERS_PKG.SI_USERS_DEL({
  'num_N_USER_ID' => num_N_USER_ID,
})

Договоры

Получение информации о договорах

SELECT("SELECT * FROM SI_V_USER_CONTRACTS")

Получение информации о договоре

SELECT("SELECT * FROM SI_V_USER_CONTRACTS WHERE N_DOC_ID = <num_N_DOC_ID>")

Добавление договора с абонентом

SI_USERS_PKG.CREATE_CONTRACT({
  'num_N_USER_ID'          => 49979801,
  'num_N_BASE_CONTRACT_ID' => 40174101,
  'num_N_CONTRACT_ID'      => NULL,
})

Редактирование договора

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'          => NULL,
})

Удаление договора

SD_DOCUMENTS_PKG.SD_DOCUMENTS_DEL({
  'num_N_DOC_ID' => num_N_DOC_ID,
})

Редактирование (создание) подписки на услуги

SI_USERS_PKG.SI_USER_GOODS_PUT({
  'num_N_SUBJ_GOOD_ID'      => num_N_SUBJ_GOOD_ID,
  'num_N_GOOD_ID'           => 22165301,
  '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'           => 1,
  'num_N_LINE_NO'           => 1000000,
  'num_N_QUANT'             => 1,
  'num_N_UNIT_ID'           => 1009,
  'num_N_DOC_ID'            => 712283101,
  'num_N_PAR_SUBJ_GOOD_ID'  => NULL,
  'dt_D_BEGIN'              => DATE('11.06.2010', 'DD.MM.YYYY'),
  'dt_D_END'                => NULL,
})

Удаление подписки на услуги

SI_USERS_PKG.SI_USER_GOODS_DEL({
  'num_N_SUBJ_GOOD_ID' => num_N_SUBJ_GOOD_ID,
})

Лицевые счета

Получение информации о счетах

SELECT("SELECT * FROM SI_V_SUBJ_ACCOUNTS WHERE N_ACCOUNT_TYPE_ID = 2042")

Получение информации о счете

SELECT("SELECT * FROM SI_V_SUBJ_ACCOUNTS WHERE N_ACCOUNT_ID = <num_N_ACCOUNT_ID>")

Добавление лицевого счета для абонента

SI_USERS_PKG.CREATE_ACCOUNT({
  'num_N_USER_ID'    => 49979801,
  'num_N_ACCOUNT_ID' => NULL,
})

Редактирование (добавление) счета

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'         => 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'),
})

Удаление счета

SI_SUBJECTS_PKG.SI_SUBJ_ACCOUNTS_DEL({
  'num_N_ACCOUNT_ID' => num_N_ACCOUNT_ID,
})

Пополнение баланса лицевого счета

SD_PAYMENTS_PKG.SD_PAYMENTS_CHARGE({
  'num_N_DOC_ID'              => NULL,
  'num_N_DOC_TYPE_ID'         => 4002,
  'num_N_PAY_TYPE_ID'         => 40492401,
  'num_N_MOVE_TYPE_ID'        => 1007,
  'num_N_ACCOUNT_ID_ForWho'   => 52481101,
  'num_N_PAYER_ID'            => 52480501,
  'num_N_RECEIVER_ID'         => 99,
  'num_N_ACCOUNT_ID_Receiver' => 40140101,
  'num_N_SUM'                 => 100,
  'num_N_TAX_RATE_ID'         => 3005,
  'num_N_CURRENCY_ID'         => 1044,
})

Получение списка платежей абонента

SELECT("SELECT * FROM TABLE(SI_USERS_PKG_S.USERS_ACC_DETALIZATION(
                            TO_DATE('<dt_D_BEGIN>', 'DD.MM.YYYY HH24:MI:SS'),
                            TO_DATE('<dt_D_END>', 'DD.MM.YYYY HH24:MI:SS'),
                            <num_N_ACCOUNT_ID>, 1, 0))")

Оборудование абонента

Получение информации об оборудовании абонентов

SELECT("SELECT * FROM SI_V_USER_DEVICES")

Получение информации об оборудовании абонента

SELECT("SELECT * FROM SI_V_USER_DEVICES WHERE N_USER_ID = <num_N_USER_ID>")

Добавление оборудования абонента

Редактирование оборудования абонента

SI_OBJECTS_PKG.SI_OBJECTS_PUT({
'num_N_OBJECT_ID' => 52508301,
'num_N_GOOD_ID' => 40376601,
'vch_VC_NAME' => 'AV1-T0100002',
'vch_VC_CODE' => 'AV1-T0100002',
'num_N_FIRM_ID' => 100,
'num_N_OBJ_STATE_ID' => 1040,
'num_N_OWNER_ID' => 52499001,
})

Удаление оборудования абонента

SI_OBJECTS_PKG.SI_OBJECTS_DEL({
  num_N_OBJECT_ID => num_N_OBJECT_ID,
})

Услуги абонента

Список текущих услуг

SELECT("SELECT * FROM TABLE(SI_USERS_PKG_S.USERS_CURRENT_SERVS_LIST(<num_N_USER_ID>, 1))")

Список оказанных услуг

SELECT("SELECT * FROM TABLE(SI_USERS_PKG_S.USERS_BILLED_SERVS_LIST(<num_N_USER_ID>, TO_DATE('<dt_D_BEGIN>', 'DD.MM.YYYY HH24:MI:SS'), TO_DATE('<dt_D_END>', 'DD.MM.YYYY HH24:MI:SS'), 1))")

Получение информации о текущей услуге

SELECT("SELECT * FROM TABLE(SI_USERS_PKG_S.USERS_CURRENT_SERVS_LIST(<num_N_USER_ID>, 1)) WHERE N_GOOD_ID = <num_N_GOOD_ID>")

Изменение состояния услуги доступа

SI_USERS_PKG.ACCESS_SERV_CHG_STATE({
  'num_N_GOOD_ID'        => 40216501,
  'num_N_PARENT_GOOD_ID' => 40161101,
  'num_N_ACCOUNT_ID'     => 52481101,
  'num_N_OBJECT_ID'      => 52482001,
  'num_N_INVOICE_ID'     => 52485101,
  'b_Enable'             => 1,
})

Получение детализации по трафику

Получение детализации по доп. услугам

SELECT("SELECT * FROM SI_V_USER_ADDSERVS WHERE N_DOC_ID = <num_N_DOC_ID> AND N_PARENT_GOOD_ID = <num_N_GOOD_ID>")

Инвойсы

Список инвойсов абонента

SELECT("SELECT D.*
        FROM   SD_V_INVOICES_JR D, SI_V_DOC_SUBJECTS_SIMPLE S
        WHERE  S.N_DOC_ID = D.N_DOC_ID
        AND    S.N_DOC_ROLE_ID = SYS_CONTEXT('CONST', 'SUBJ_ROLE_Receiver')
        AND    S.N_SUBJECT_ID = <num_N_USER_ID>")

Получение заголовка инвойса

SELECT("SELECT * FROM SD_V_INVOICES_T WHERE N_DOC_ID = <num_N_DOC_ID>")

Получение состава инвойса

SELECT("SELECT * FROM SD_V_INVOICES_C WHERE N_DOC_ID = <num_N_DOC_ID>")

Изменение состояния инвойса

SD_DOCUMENTS_CHANGE_STATE(
  'num_N_DOC_ID'           => 52485101,
  'num_N_New_DOC_STATE_ID' => 4003,
})

Досрочное закрытие инвойса

SI_USERS_PKG.CHANGE_INVOICE_PERIOD({
  'num_N_DOC_ID' => 52485101,
  'dt_D_OPER'    => DATE('11.06.2010 23:11:02', 'DD.MM.YYYY HH24:MI:SS')
})

Подписки на службы

Получение информации о подписках на службы

SELECT("SELECT * FROM SI_V_SUBJ_SERVICES WHERE N_SUBJ_SERV_TYPE_ID = SYS_CONTEXT('CONST','SUBJ_SERV_ServiceUse')")

Получение информации о подписках на службы абонента

SELECT("SELECT * FROM SI_V_SUBJ_SERVICES WHERE N_SUBJ_SERV_TYPE_ID = SYS_CONTEXT('CONST','SUBJ_SERV_ServiceUse') AND N_SUBJECT_ID = <num_N_USER_ID>")

Получение информации о подписке на службу

SELECT("SELECT * FROM SI_V_SUBJ_SERVICES WHERE N_SUBJ_SERV_TYPE_ID = SYS_CONTEXT('CONST','SUBJ_SERV_ServiceUse') AND N_SUBJ_SERV_ID = <num_N_SUBJ_SERV_ID>")

Редактирование (добавление) подписки на службу

SI_SUBJECTS_PKG.SI_SUBJ_SERVICES_PUT({
  'num_N_SUBJ_SERV_ID'      => num_N_SUBJ_SERV_ID,
  'num_N_SUBJ_SERV_TYPE_ID' => 3066,
  'num_N_SUBJECT_ID'        => 52480701,
  'num_N_SERVICE_ID'        => 40176501,
  'num_N_OBJECT_ID'         => 54154801,
  'num_N_AUTH_TYPE_ID'      => 1019,
  'vch_VC_LOGIN'            => 'T0100001',
})

Удаление подписки на службу

SI_SUBJECTS_PKG.SI_SUBJ_SERVICES_DEL({
  'num_N_SUBJ_SERV_ID'      => num_N_SUBJ_SERV_ID,
})

Изменение пароля на подписку к службе

SI_SUBJECTS_PKG.SI_SUBJ_SERVICES_CHG_PASS({
  'num_N_SUBJ_SERV_ID' => 42231101,
  'vch_VC_OLD_PASS'    => NULL,
  'vch_VC_NEW_PASS'    => 'q123',
})

Доступ к приложениям

Получение информации о доступе к приложениям

SELECT("SELECT * FROM SI_V_SUBJ_SERVICES WHERE N_SUBJ_SERV_TYPE_ID = SYS_CONTEXT('CONST','SUBJ_SERV_AppAccess')")

Получение информации о доступе к приложениям по абоненту

SELECT("SELECT * FROM SI_V_SUBJ_SERVICES WHERE N_SUBJ_SERV_TYPE_ID = SYS_CONTEXT('CONST','SUBJ_SERV_AppAccess') AND N_SUBJECT_ID = <num_N_USER_ID>")

Получение информации о доступе к приложению

SELECT("SELECT * FROM SI_V_SUBJ_SERVICES WHERE N_SUBJ_SERV_TYPE_ID = SYS_CONTEXT('CONST','SUBJ_SERV_AppAccess') AND N_SUBJ_SERV_ID = <num_N_SUBJ_SERV_ID>")

Редактирование (добавление) доступа в приложение

SI_SUBJECTS_PKG.SI_SUBJ_SERVICES_PUT({
  'num_N_SUBJ_SERV_ID'      => num_N_SUBJ_SERV_ID,
  'num_N_SUBJ_SERV_TYPE_ID' => 3066,
  'num_N_SUBJECT_ID'        => 52480701,
  'num_N_SERVICE_ID'        => 1005,
  'num_N_AUTH_TYPE_ID'      => 1019,
  'vch_VC_LOGIN'            => 'uralsky',
})

Удаление доступа к приложению

SI_SUBJECTS_PKG.SI_SUBJ_SERVICES_DEL({
  'num_N_SUBJ_SERV_ID'      => num_N_SUBJ_SERV_ID,
})

Изменение пароля на доступ к приложению

SI_SUBJECTS_PKG.SI_SUBJ_SERVICES_CHG_PASS({
  'num_N_SUBJ_SERV_ID' => 42231101,
  'vch_VC_OLD_PASS'    => NULL,
  'vch_VC_NEW_PASS'    => 'q123',
})

Проверка авторизационных данных абонента по приложению