Документация iSZN

pkSisHcs.sql

Ошибки

Error_NoService

PROCEDURE Error_NoService(iServiceID PLS_INTEGER);

Описание

Вызывает exception “Сервис ... не найден”.

Error_NoSvcOperation

PROCEDURE Error_NoSvcOperation(iOperationID PLS_INTEGER);

Описание

Вызывает exception “Операция сервиса ... не найдена”.

Error_NoOrganization

PROCEDURE Error_NoOrganization(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Вызывает exception “Организация ... не найдена”.

Error_NoSystem

PROCEDURE Error_NoSystem(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Вызывает exception “Информационная система ... не найдена”.

Error_NoRequest

PROCEDURE Error_NoRequest(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Вызывает exception “Запрос ... не существует”.

Error_RequestLocked

PROCEDURE Error_RequestLocked(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Вызывает exception “Запрос ... заблокирован”.

Error_RequestDataEmpty

PROCEDURE Error_RequestDataEmpty(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Вызывает exception “Данные для запроса ... отсутствуют”.

Error_NoRequestSisHcsGuid

PROCEDURE Error_NoRequestSisHcsGuid(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Вызывает exception “У запроса ... отсутствует идентификатор в ГИС ЖКХ”.

Error_NoRequestCall

PROCEDURE Error_NoRequestCall(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Вызывает exception “Запись отправки запроса ... не существует”.

Error_RequestCallLocked

PROCEDURE Error_RequestCallLocked(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Вызывает exception “Запись отправки запроса ... заблокирована”.

Error_CallIsNotDelivered

PROCEDURE Error_CallIsNotDelivered(iRegionID PLS_INTEGER, iCallID PLS_INTEGER);

Описание

Вызывает exception “Запрос не был доставлен...”.

Error_ReplyDataEmpty

PROCEDURE Error_ReplyDataEmpty(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Вызывает exception “Данные ответа ... отсутствуют”.

Error_CallIsNotAPoll

PROCEDURE Error_CallIsNotAPoll(iRegionID PLS_INTEGER, iID PLS_INTEGER);

Описание

Вызывает exception “Запись отправки запроса ... не является опросом состояния”.

Привилегии на сервисы ГИС ЖКХ

GetUserGroupServicePrivs

FUNCTION GetUserGroupServicePrivs(iUserGroupID PLS_INTEGER, iServiceID PLS_INTEGER, iIsPermission PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает привилегии группы пользователей на сервис ГИС ЖКХ.
Параметры:

  • iUserGroupID - ID группы пользователей;
  • iServiceID - ID сервиса;
  • iIsPermission - какой вид привилегий требуется получить: 0 - запрещение, 1 - разрешение.

Возвращает набор указанных привилегий в виде битовой маски. Если привилегии отсутствуют, возвращает 0.

SetUserGroupServicePrivs

PROCEDURE SetUserGroupServicePrivs(iUserGroupID PLS_INTEGER, iServiceID PLS_INTEGER, iPermittedPrivs PLS_INTEGER, iRestrictedPrivs PLS_INTEGER);

Описание

Устанавливает привилегии группы пользователей на сервис ГИС ЖКХ.
Параметры:

  • iUserGroupID - ID группы пользователей;
  • iServiceID - ID сервиса;
  • iPermittedPrivs - набор разрешений в виде битовой маски;
  • iRestrictedPrivs - набор запрещений в виде битовой маски.

GetServiceUserPrivs

FUNCTION GetServiceUserPrivs(iServiceID PLS_INTEGER, sUserName VARCHAR2 := USER) RETURN PLS_INTEGER;

Описание

Возвращает привилегии указанного пользователя на сервис ГИС ЖКХ в виде битовой маски.
Параметры:

  • iServiceID - ID сервиса;
  • sUserName - имя пользователя СУБД.

CheckServicePriv

PROCEDURE CheckServicePriv(iServiceID PLS_INTEGER, iPriv PLS_INTEGER);

Описание

Проверяет, что у текущего пользователя есть все указанные привилегии на сервис ГИС ЖКХ.
Параметры:

  • iServiceID - ID сервиса;
  • iPriv - сумма битовых флагов проверяемых привилегий.

Работа с сервисами и их операциями

GetServiceName

FUNCTION GetServiceName(iServiceID PLS_INTEGER, iNameKind PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает наименование сервиса ГИС ЖКХ.
Параметры:

  • iServiceID - ID сервиса;
  • iNameKind - вид наименование: 0 - техническое, 1 - отображаемое;
  • iStrict - поведение при отсутствии указанного сервиса.

GetSvcOperationName

FUNCTION GetSvcOperationName(iOperationID PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает наименование операции сервиса ГИС ЖКХ.
Параметры:

  • iOperationID - ID операции;
  • iStrict - поведение при отсутствии операции.

Конфигурация

GetISSlurpKey

FUNCTION GetISSlurpKey(iRegionID PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает Slurp-ключ информационной системы ГИС ЖКХ из региональных настроек экземпляра Системы.
Параметры:

  • iRegionID - ID района, для которого необходимо получить значение настройки;
  • iStrict - определяет поведение при отсутствии значения настройки.

GetISKey

PROCEDURE GetISKey(iRegionID PLS_INTEGER, iStrict PLS_INTEGER, iSystemRgnID OUT PLS_INTEGER, iSystemID OUT PLS_INTEGER);

Описание

Возвращает районный ключ информационной системы ГИС ЖКХ из региональных настроек экземпляра Системы.
Входные параметры:

  • iRegionID - ID района, для которого необходимо получить значение настройки;
  • iStrict - определяет поведение при отсутствии значения настройки.

Выходные параметры:

  • iSystemRgnID, iSystemID - ключ информационной системы или null.

GetISOperatorKey

PROCEDURE GetISOperatorKey(iSystemRgnID PLS_INTEGER, iSystemID PLS_INTEGER, iStrict PLS_INTEGER, iOperatorRgnID OUT PLS_INTEGER, iOperatorID OUT PLS_INTEGER);

Описание

Возвращает районный ключ оператора ИС ГИС ЖКХ.
Входные параметры:

  • iSystemRgnID, iSystemID - ключ ИС, для которой необходимо получить оператора;
  • iStrict - определяет поведение при отсутствии ИС.

Выходные параметры:

  • iOperatorRgnID, iOperatorID - ключ оператора ИС или null.

GetOrganizationName

FUNCTION GetOrganizationName(iRegionID PLS_INTEGER, iID PLS_INTEGER, iStrict PLS_INTEGER, iDisplayMode PLS_INTEGER := 0) RETURN VARCHAR2;

Описание

Возвращает наименование организации, зарегистрированной в ГИС ЖКХ.
Параметры:

  • iRegionID, iID - ключ организации;
  • iStrict - поведение при отсутствии указанной организации;
  • iDisplayMode - способ вывода результата, как для pkGen.FormatNameWithRKey.

GetOrganizationPPAGUID

FUNCTION GetOrganizationPPAGUID(iRegionID PLS_INTEGER, iID PLS_INTEGER, iStrict PLS_INTEGER) RETURN RAW;

Описание

Возвращает PPAGUID организации, зарегистрированной в ГИС ЖКХ.
Параметры:

  • iRegionID, iID - ключ организации;
  • iStrict - поведение при отсутствии указанной организации.

GetOrganizationSigCertInfo

PROCEDURE GetOrganizationSigCertInfo(iOrganizationRgnID PLS_INTEGER, iOrganizationID PLS_INTEGER, sKeyContainerName OUT VARCHAR2, iGostVersion OUT PLS_INTEGER);

Описание

Возвращает информацию о сертификате подписи организации, зарегистрированной в ГИС ЖКХ.
Входные параметры:

  • iOrganizationRgnID, iOrganizationID - ключ организации.

Выходные параметры:

  • sKeyContainerName - наименование ключевого контейнера;
  • iGostVersion - идентификатор версии ГОСТ ЭП.

Если организация не существует или для неё не задан сертификат ЭП, возникает exception.

GetISName

FUNCTION GetISName(iRegionID PLS_INTEGER, iID PLS_INTEGER, iNameKind PLS_INTEGER, iStrict PLS_INTEGER, iDisplayMode PLS_INTEGER := 0) RETURN VARCHAR2;

Описание

Возвращает наименование информационной системы, зарегистрированной в ГИС ЖКХ.
Параметры:

  • iRegionID, iID - ключ информационной системы;
  • iNameKind - вид наименования: 1 - полное, 2 - краткое;
  • iStrict - поведение при отсутствии указанной информационной системы;
  • iDisplayMode - способ вывода результата, как для pkGen.FormatNameWithRKey.

GetISGUID

FUNCTION GetISGUID(iRegionID PLS_INTEGER, iID PLS_INTEGER, iStrict PLS_INTEGER) RETURN RAW;

Описание

Возвращает GUID информационной системы, зарегистрированной в ГИС ЖКХ.
Параметры:

  • iRegionID, iID - ключ информационной системы;
  • iStrict - поведение при отсутствии указанной информационной системы.

GetUserGUID

FUNCTION GetUserGUID(iOrgRgnID PLS_INTEGER, iOrgID PLS_INTEGER, sUsername VARCHAR2, iUseDefault PLS_INTEGER, iStrict PLS_INTEGER) RETURN RAW;

Описание

Возвращает GUID пользователя ГИС ЖКХ.
Параметры:

  • iOrgRgnID, iOrgID - ключ организации ГИС ЖКХ;
  • sUsername - имя пользователя Системы;
  • iUseDefault - использовать ли пользователя по умолчанию, если указанный пользователь не является пользователем данной организации;
  • iStrict - определяет поведение при отсутствии значения.

GetServiceBaseURL

FUNCTION GetServiceBaseURL(iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает префикс URL для отправки запросов к сервисам.
Значение берётся из настройки SIS_HCS_SERVICE_URL.
Параметры:

  • iStrict - поведение в случае, если значение настройки не задано.

GetServiceRequestURL

FUNCTION GetServiceRequestURL(iServiceID PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает URL для отправки запросов к сервису.
Параметры:

  • iServiceID - ID сервиса;
  • iStrict - поведение в случае, если сервис не существует или значение настройки SIS_HCS_SERVICE_URL не задано.

Перекодировка справочников

EncodeIdentityDocType

FUNCTION EncodeIdentityDocType(iInternalKey PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Перекодировка вида ДУЛ из iSZN в ГИС ЖКХ.

FormatIdentitySerNum

PROCEDURE FormatIdentitySerNum(iDocType PLS_INTEGER, iDocClassID PLS_INTEGER, sSeries IN OUT VARCHAR2, sNumber IN OUT VARCHAR2);

Описание

Форматирует серию и номер ДУЛ в соответствии с требованиями ГИС ЖКХ.
Параметры:

  • iDocType - код документа по ГИС ЖКХ;
  • iDocClassID - ID класса документа в iSZN (игнорируется, если соответствие однозначное);
  • sSeries - серия документа в iSZN;
  • sNumber - номер документа в iSZN.

Отправка и обработка запросов

AllocateNewRequestID

FUNCTION AllocateNewRequestID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает новый ID записи запроса в заданном районе.

AllocateNewCallID

FUNCTION AllocateNewCallID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает новый ID записи отправки запроса в заданном районе.

AllocateNewCallProcID

FUNCTION AllocateNewCallProcID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает новый ID записи обработки ответа на запрос в заданном районе.

AllocateNewExpDataID

FUNCTION AllocateNewExpDataID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает новый ID записи выгруженных сведений в заданном районе.

LockRequest

PROCEDURE LockRequest(iRegionID PLS_INTEGER, iRequestID PLS_INTEGER);

Описание

Устанавливает эксклюзивную блокировку на запрос в ГИС ЖКХ.
Параметры:

  • iRegionID, iRequestID - ключ сообщения.

Если запрос не существует или заблокирован, возникает exception.

CheckRequestServicePriv

PROCEDURE CheckRequestServicePriv(iRegionID PLS_INTEGER, iRequestID PLS_INTEGER, iPriv PLS_INTEGER);

Описание

Проверяет привилегии пользователя на работу с сервисом ГИС ЖКХ для указанного запрос.
Параметры:

  • iRegionID, iRequestID - ключ запроса;
  • iPriv - битовая маска проверяемых привилегий.

Если запрос не существует или пользователь не имеет необходимых привилегий на работу с сервисом, возникает
соответствующий exception.

ScheduleRequest

FUNCTION ScheduleRequest(
  iRegionID PLS_INTEGER, iOperationID PLS_INTEGER, iSenderRgnID PLS_INTEGER, iSenderID PLS_INTEGER,
  cData CLOB, sDataAttribs VARCHAR2, sVersion VARCHAR2, iPostpone PLS_INTEGER, iCompressData PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Создаёт и ставит в очередь на отправку запрос к сервису ГИС ЖКХ.
Параметры:

  • iRegionID - ID района сообщения;
  • iOperationID - ID операции сервиса;
  • iSenderRgnID, iSenderID - ключ отправителя запроса; если null, запрос отправляется от имени оператора ИС;
  • cData - предметные данные запроса;
  • sDataAttribs - дополнительные атрибуты для предметных данных запроса;
  • sVersion - версия сервиса для атрибута base:version; если null, атрибут не добавляется;
  • iPostpone - отложить ли отправку (0/1);
  • iCompressData - сжимать ли данные (0/1).

Возвращает ID записи запроса.
Если пользователь не имеет необходимых привилегий на сервис, возникает exception.

ScheduleCall

FUNCTION ScheduleCall(iRegionID PLS_INTEGER, iRequestID PLS_INTEGER, dNewTime DATE) RETURN DATE;

Описание

Задаёт время отправки или опроса состояния обработки для существующего запроса.
Возвращает предыдущее значение времени отправки.
Параметры:

  • iRegionID, iRequestID - ключ запроса;
  • dNewTime - желаемая дата и время отправки.

Если запрос не существует, заблокирован или пользователь не имеет необходимых привилегий, возникает exception.

UnscheduleRequest

FUNCTION UnscheduleRequest(iRegionID PLS_INTEGER, iRequestID PLS_INTEGER) RETURN DATE;

Описание

Отменяет отправку запроса или опроса состояния обработки запроса.
Параметры:

  • iRegionID, iRequestID - ключ запроса.

Если запрос не существует или заблокирован или пользователь не имеет необходимых привилегий, возникает exception.

GetCallToProcessKeys

FUNCTION GetCallToProcessKeys(iiRegionIDs uszn.TIntegerList, iMaxRecordCount PLS_INTEGER) RETURN uszn.TRgnKeyList;

Описание

Возвращает список ключей записей об отправке запроса, подлежащих обработке.
Параметры:

  • iiRegionIDs - список ID рабочих районов;
  • iMaxRecordCount - максимальное допустимое количество записей, которое возвращает функция.

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

GetPollIndex

FUNCTION GetPollIndex(iRegionID PLS_INTEGER, iCallID PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Возвращает порядковый номер записи опроса состояния обработки запроса, начиная с 1.
Учитываются только записи, доставленные в ГИС ЖКХ.
Параметры:

  • iRegionID, iCallID - ключ опроса состояния обработки запроса.

Если запись не является записью опроса состояния или не существует, возникает exception.

ProcessResult

FUNCTION ProcessResult(iRegionID PLS_INTEGER, iCallID PLS_INTEGER, iAudOriginID PLS_INTEGER, sAudNotes VARCHAR2 := NULL) RETURN PLS_INTEGER;

Описание

Обрабатывает результат отправки запроса.
Параметры:

  • iRegionID, iCallID - ключ записи об отправке;
  • iAudOriginID - источник события для аудита;
  • sAudNotes - примечания для аудита.

Возвращает ID созданной записи об обработке.

SetExportedDataRequest

PROCEDURE SetExportedDataRequest(iRegionID PLS_INTEGER, iRequestID PLS_INTEGER, iiDataIDs uszn.TIntegerList);

Описание

Привязывает отправленные данные к запросу к сервису ГИС ЖКХ.
Параметры:

  • iRegionID, iRequestID - ключ запроса;
  • iiDataIDs - ID отправленных в составе запроса данных.

Сервис общесистемной НСИ (hcs-nsi-common)

NsiCommon_ExportNsiList

FUNCTION NsiCommon_ExportNsiList(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;

Описание

Отправляет запрос exportNsiListRequest.
Параметры:

  • iRegionID - ID рабочего района, в котором будет создан запрос.

Возвращает ID созданного запроса.

Сервис информации о мерах социальной поддержки (hcs-msp)

GetSubsidyAsgIDs104

FUNCTION GetSubsidyAsgIDs104(iRegionID PLS_INTEGER) RETURN uszn.pkGen.TIntegers;

Описание

Возвращает список ID назначений для выгрузки сведений о получателях субсидий ЖКУ (ДСЗН ЯНАО).
Параметры:

  • iRegionID - ID района.

PrepareImportCitizenSubsidy104

PROCEDURE PrepareImportCitizenSubsidy104(
  iRegionID PLS_INTEGER, iAsgID PLS_INTEGER,
  cTag OUT CLOB, iiDataIDs OUT uszn.pkGen.TIntegers);
-- Возвращает ключ объекта для выгрузки сведений о получателях ЖКВ (ДСЗН ЯНАО).
-- Параметры:
--   iAsgID  - ID назначения;
--   iCollID - ID коллектива, для которого рассчитано назначение.
-- В качестве ключа используется To_Char(<ID назначения>)-To_Char(<ID коллектива class_id=46>).
FUNCTION  GetCompensationObjKey104(iAsgID PLS_INTEGER, iCollID PLS_INTEGER) RETURN VARCHAR2;

Описание

Готовит данные для операции “Импорт сведений о гражданине, получающем субсидии” (ДСЗН ЯНАО).
Входные параметры:

  • iRegionID, iAsgID - ключ назначенной выплаты “Субсидия на оплату жилья и коммунальных услуг” (000-127).

Выходные параметры:

  • cTag - содержимое тега;
  • iiDataIDs - список ID выгружаемых объектов.

Если назначение не существует или данные выгружать не требуется, cTag будет null.
Если выгрузка требуется, в cTag помещается заполненный тег <importCitizenSubsidy>, а соответствующие записи о
выгрузке сведений в ГИС ЖКХ рекурсивно добавляются/обновляются и их ID добавляются в iiDataIDs.
Если при формировании сведений недостаточно обязательных данных, возникает exception.

GetCompensationObjKey104

FUNCTION GetCompensationObjKey104(iAsgID PLS_INTEGER, iCollID PLS_INTEGER) RETURN VARCHAR2;

Описание

Возвращает ключ объекта для выгрузки сведений о получателях ЖКВ (ДСЗН ЯНАО).
Параметры:

  • iAsgID - ID назначения;
  • iCollID - ID коллектива, для которого рассчитано назначение.

В качестве ключа используется To_Char(<ID назначения>)-To_Char(<ID коллектива class_id=46>).

ParseCompensationObjKey104

PROCEDURE ParseCompensationObjKey104(sObjKey VARCHAR2, iAsgID OUT PLS_INTEGER, iCollID OUT PLS_INTEGER);

Описание

Разбирает ключ объекта для выгрузки сведений о получателях ЖКВ (ДСЗН ЯНАО).
Входные параметры:

  • sObjKey - ключ объекта.

Выходные параметры:

  • iAsgID - ID назначения;
  • iCollID - ID коллектива, для которого рассчитано назначение.

Если ключ пустой, возвращает null. Если ключ некорректен, возникает exception.

GetCompensationObjKeys104

FUNCTION GetCompensationObjKeys104(iRegionID PLS_INTEGER) RETURN uszn.pkGen.TStrings255;

Описание

Возвращает список ключей объектов для выгрузки сведений о получателях ЖКВ (ДСЗН ЯНАО).
Параметры:

  • iRegionID - ID района.

PrepareImportCitizenCompens104

PROCEDURE PrepareImportCitizenCompens104(
  iRegionID PLS_INTEGER, iAsgID PLS_INTEGER, iCollID PLS_INTEGER,
  cTag OUT CLOB, iiDataIDs OUT uszn.pkGen.TIntegers);
 
/*********************************************************************************************************************
 Разное
*********************************************************************************************************************/
 
-- Возвращает список ID выгруженных объектов, непосредственно или косвенно связанных с запросом к сервису.
-- Параметры:
--   iRegionID, iRequestID - ключ запроса.
FUNCTION  GetRequestRelatedExpDataIDs(iRegionID PLS_INTEGER, iRequestID PLS_INTEGER) RETURN uszn.TIntegerList;

Описание

Готовит данные для операции “Импорт сведений о гражданах, получающих компенсации расходов” (ДСЗН ЯНАО).
Входные параметры:

  • iRegionID, iAsgID - ключ назначенной выплаты “Возмещение расходов оплаты жилья, коммунальных услуг и топлива (ЖКВ)” (104-29);
  • iCollID - ID коллектива, для которого будет браться адрес.

Выходные параметры:

  • cTag - содержимое тега;
  • iiDataIDs - список ID выгружаемых объектов.

Разное

GetRequestRelatedExpDataIDs

FUNCTION GetRequestRelatedExpDataIDs(iRegionID PLS_INTEGER, iRequestID PLS_INTEGER) RETURN uszn.TIntegerList;

Описание

Возвращает список ID выгруженных объектов, непосредственно или косвенно связанных с запросом к сервису.
Параметры:

  • iRegionID, iRequestID - ключ запроса.