Документация iSZN
pkSMEV3.sql
Ошибки
Error_SvcNotConfigured
PROCEDURE Error_SvcNotConfigured;
Описание
Вызывает exception “Сервисы обмена сообщениями СМЭВ-3 не сконфигурированы”.
Error_InvalidInMessageKind
PROCEDURE Error_InvalidInMessageKind(iMessageKindID PLS_INTEGER);
Описание
Вызывает exception “Неизвестный вид входящего сообщения...”.
Error_InvalidOutMessageKind
PROCEDURE Error_InvalidOutMessageKind(iMessageKindID PLS_INTEGER);
Описание
Вызывает exception “Неизвестный вид исходящего сообщения...”.
Error_NoDataKind
PROCEDURE Error_NoDataKind(iRegionID PLS_INTEGER, iID PLS_INTEGER);
Описание
Вызывает exception “Вид сведений ... не найден”.
Error_NoDKScriptKind
PROCEDURE Error_NoDKScriptKind(iID PLS_INTEGER);
Описание
Вызывает exception “Вид SQL-сценария для вида сведений ... не найден”.
Error_NoDKAttrib
PROCEDURE Error_NoDKAttrib(iAttribRegionID PLS_INTEGER, iAttribID PLS_INTEGER);
Описание
Вызывает exception “Атрибут вида сведений ... не найден”.
Error_NoDKAttribValue
PROCEDURE Error_NoDKAttribValue(iDataKindRegionID PLS_INTEGER, iDataKindID PLS_INTEGER, iAttribRegionID PLS_INTEGER, iAttribID PLS_INTEGER);
Описание
Вызывает exception “Значение атрибута вида сведений не задано”.
Error_InvalidDKAttribValue
PROCEDURE Error_InvalidDKAttribValue(iDataKindRegionID PLS_INTEGER, iDataKindID PLS_INTEGER, iAttribRegionID PLS_INTEGER, iAttribID PLS_INTEGER);
Описание
Вызывает exception “Значение атрибута вида сведений некорректно”.
Error_DKAttribValueTooLong
PROCEDURE Error_DKAttribValueTooLong(iDataKindRegionID PLS_INTEGER, iDataKindID PLS_INTEGER, iAttribRegionID PLS_INTEGER, iAttribID PLS_INTEGER, iMaxValueLen PLS_INTEGER);
Описание
Вызывает exception “Значение атрибута вида сведений превышает допустимую длину”.
Error_DKIncompatiblePDoc
PROCEDURE Error_DKIncompatiblePDoc(iDataKindRegionID PLS_INTEGER, iDataKindID PLS_INTEGER, iPDocClassID PLS_INTEGER);
Описание
Вызывает exception “Документ несовместим с видом сведений”.
Error_NoDataKindNSURI
PROCEDURE Error_NoDataKindNSURI(iRegionID PLS_INTEGER, sNSURI VARCHAR2);
Описание
Вызывает exception “Для района не найден вид сведений, NS=...”.
Error_InMessageLocked
PROCEDURE Error_InMessageLocked(iID PLS_INTEGER);
Описание
Вызывает exception “Входящее сообщение ... заблокировано”.
Error_NoIncomingMessage
PROCEDURE Error_NoIncomingMessage(iID PLS_INTEGER);
Описание
Вызывает exception “Входящее сообщение ... не найдено”.
Error_NoIncomingMessage
Error_NoInMsgProcessing
PROCEDURE Error_NoInMsgProcessing(iID PLS_INTEGER);
Описание
Вызывает exception “Запись обработки входящего сообщения ... не найдена”.
Error_OutMessageLocked
PROCEDURE Error_OutMessageLocked(iRegionID PLS_INTEGER, iID PLS_INTEGER);
Описание
Вызывает exception “Исходящее сообщение ... заблокировано”.
Error_NoOutgoingMessage
PROCEDURE Error_NoOutgoingMessage(iRegionID PLS_INTEGER, iID PLS_INTEGER);
Описание
Вызывает exception “Исходящее сообщение ... не найдено”.
Error_NoOutgoingMessage
Error_NoOutMessageFile
PROCEDURE Error_NoOutMessageFile(iRegionID PLS_INTEGER, iID PLS_INTEGER);
Описание
Вызывает exception “Файл исходящего сообщения ... не найден”.
Error_NoOutMessageCall
PROCEDURE Error_NoOutMessageCall(iRegionID PLS_INTEGER, iID PLS_INTEGER);
Описание
Вызывает exception “Запись отправки исходящего сообщения ... не найдена”.
Error_NoOutMsgCallProcessing
PROCEDURE Error_NoOutMsgCallProcessing(iRegionID PLS_INTEGER, iID PLS_INTEGER);
Описание
Вызывает exception “Запись обработки отправленного исходящего сообщения ... не найдена”.
Error_OutMsgIsNotDelivered
PROCEDURE Error_OutMsgIsNotDelivered(iRegionID PLS_INTEGER, iCallID PLS_INTEGER);
Описание
Вызывает exception “Исходящее сообщение ... не было доставлено”.
Error_OutMsgHasNoData
PROCEDURE Error_OutMsgHasNoData(iRegionID PLS_INTEGER, iID PLS_INTEGER);
Описание
Вызывает exception “Исходящее сообщение не содержит данных”.
Конфигурация
GetDefaultSMEVVersionID
FUNCTION GetDefaultSMEVVersionID(iStrict PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает ID версии СМЭВ, используемой при отправке сообщений. Выбирается версия, для которой сконфигурированы параметры подключения вызываемого веб-сервиса. Если параметры подключения сконфигурированы более чем одного сервиса, выбирается более приоритетная версия по справочнику версий СМЭВ. Если сервисы с заданными параметрами подключения отсутствуют, поведение определяется параметром iStrict.
GetMaxFailedOutMsgCallCount
FUNCTION GetMaxFailedOutMsgCallCount RETURN PLS_INTEGER;
Описание
Возвращает максимальное количество сбоев при отправке исходящего сообщения, после которого его отправка прекращается.
GetFailedOutMsgCallTimeout
FUNCTION GetFailedOutMsgCallTimeout(iFailCount PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает интервал в секундах между повторными вызовами в случае сбоя при отправке исходящего сообщения. TODO: необходимо иметь настройки в зависимости от вида сведений!!!
GetOutMsgTimeoutSecs
FUNCTION GetOutMsgTimeoutSecs(iOperationRegionID PLS_INTEGER, iOperationID PLS_INTEGER, iDataKindRegionID PLS_INTEGER, iDataKindID PLS_INTEGER, iIsFirstCall PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает задержку в секундах до отправки исходящего сообщения с момента постановки его в очередь или после
получения ответа, требующего повторной отправки.
Параметры:
- iOperationRegionID, iOperationID - ключ операции;
- iDataKindRegionID, iDataKindID - ключ вида сведений;
- iIsFirstCall - первая ли это отправка сообщения (1) или повторная (0);
- iStrict - определяет поведение, если операция не существует, значение атрибута не задано или ошибочно.
GetParticipantKey
FUNCTION GetParticipantKey(iRegionID PLS_INTEGER, sSystemCode VARCHAR2, iStrictExists PLS_INTEGER, iStrictUnique PLS_INTEGER) RETURN uszn.TRgnKey;
Описание
Возвращает ключ участника взаимодействия по мнемонике системы.
Параметры:
- iRegionID - ID района запроса; поиск производится вверх по иерархии районов;
- sSystemCode - мнемоника системы в СМЭВ-3;
- iStrictExists - определяет поведение при отсутствии в справочнике системы с такой мнемоникой;
- iStrictUnique - определяет поведение при обнаружении в справочнике более одной системы с такой мнемоникой.
GetDefaultParticipantKey
PROCEDURE GetDefaultParticipantKey(iRegionID PLS_INTEGER, iStrict PLS_INTEGER, iParticipantRgnID OUT PLS_INTEGER, iParticipantID OUT PLS_INTEGER);
Описание
Возвращает районный ключ участника взаимодействия по умолчанию.
Значение берётся из региональных настроек экземпляра Системы.
Входные параметры:
- iRegionID - ID района, для которого необходимо получить значение настройки;
- iStrict - определяет поведение при отсутствии значения настройки.
Выходные параметры:
- iParticipantRgnID, iParticipantID - ключ участника взаимодействия или null.
GetDefaultParticipantSlurpKey
FUNCTION GetDefaultParticipantSlurpKey(iRegionID PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает Slurp-ключ участника взаимодействия по умолчанию.
Значение берётся из региональных настроек экземпляра Системы.
Параметры:
- iRegionID - ID района, для которого необходимо получить значение настройки;
- iStrict - определяет поведение при отсутствии значения настройки.
GetDefaultLeafRgnID
FUNCTION GetDefaultLeafRgnID(iRegionID PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает ID листьевого района по умолчанию для отправки исходящих сообщений.
Значение берётся из региональных настроек экземпляра Системы.
Параметры:
- iRegionID - ID района, для которого необходимо получить значение настройки;
- iStrict - определяет поведение при отсутствии значения настройки.
Работа со справочником веб-сервисов
IsSmevPollOperation
FUNCTION IsSmevPollOperation(iRegionID PLS_INTEGER, iID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Определяет, предназначена ли операция для опроса очереди входящих сообщений СМЭВ-3 (0/1).
Параметры:
- iRegionID, iID - ключ операции сервиса.
При отсутствии такой операции возвращает 0.
GetSendRequestOperation
PROCEDURE GetSendRequestOperation(iRegionID PLS_INTEGER, iSMEVVersionID PLS_INTEGER, iOperationRegionID OUT PLS_INTEGER, iOperationID OUT PLS_INTEGER);
Описание
Поиск операции веб-сервиса для отправки запроса.
Входные параметры:
- iRegionID - ID района предполагаемого запроса; пока игнорируется;
- iSMEVVersionID - ID версии СМЭВ; если null, используется версия СМЭВ по умолчанию.
Выходные параметры:
- iOperationRegionID, iOperationID - найденной ключ операции веб-сервиса.
Если операция не найдена или найдена неоднозначно, возникает exception.
GetSendResponseOperation
PROCEDURE GetSendResponseOperation(iRegionID PLS_INTEGER, iSMEVVersionID PLS_INTEGER, iOperationRegionID OUT PLS_INTEGER, iOperationID OUT PLS_INTEGER);
Описание
Поиск операции веб-сервиса для отправки ответа.
Входные параметры:
- iRegionID - ID района предполагаемого запроса; пока игнорируется;
- iSMEVVersionID - ID версии СМЭВ; если null, используется версия СМЭВ по умолчанию.
Выходные параметры:
- iOperationRegionID, iOperationID - найденной ключ операции веб-сервиса.
Если операция не найдена или найдена неоднозначно, возникает exception.
Виды сведений
GetDataKindName
FUNCTION GetDataKindName(iRegionID PLS_INTEGER, iID PLS_INTEGER, iStrict PLS_INTEGER, iDisplayMode PLS_INTEGER := 0) RETURN VARCHAR2;
Описание
Возвращает наименование вида сведений.
Параметры:
- iRegionID, iID - ключ вида сведений;
- iStrict - поведение при отсутствии указанного вида сведений;
- iDisplayMode - способ вывода результата, как для pkGen.FormatNameWithRKey.
GetDataKind
PROCEDURE GetDataKind(iRequestRegionID PLS_INTEGER, sNSURI VARCHAR2, iDataKindRegionID OUT PLS_INTEGER, iDataKindID OUT PLS_INTEGER, iStrict PLS_INTEGER);
Описание
Выполняет поиск вида сведений для заданного района по URI пространства имён.
Параметры:
- iRequestRegionID - район, для которого адресован запрос;
- sNSURI - URI пространства имён;
- iDataKindRegionID, iDataKindID - ключ вида сведений, найденного в результате поиска;
- iStrict - определяет поведение при отсутствии вида сведений.
Поиск осуществляется в районе запроса и выше по иерархии районов; если подходящих видов сведений несколько, берётся
вид сведений с наибольшим уровнем района в иерархии (т. е. виды сведений, определённые в дочерних районах,
переопределяют виды сведений, объявленные выше по иерархии районов).
GetDKScriptKindName
FUNCTION GetDKScriptKindName(iScriptKindID PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает наименование вида SQL-сценария вида сведений.
Параметры:
- iScriptKindID - ID вида сценария;
- iStrict - определяет поведение при отсутствии такого вида сценария.
GetDataKindScript
FUNCTION GetDataKindScript(iDataKindRegionID PLS_INTEGER, iDataKindID PLS_INTEGER, iScriptKindID PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает SQL-сценарий определённого вида для заданного вида сведений.
Параметры:
- iDataKindRegionID, iDataKindID - ключ вида сведений;
- iScriptKindID - ID вида сценария;
- iStrict - определяет поведение, если вид данных не существует, сценарий отсутствует или пустой.
GetDataKindProcInMsgResultSQL
FUNCTION GetDataKindProcInMsgResultSQL(iDataKindRegionID PLS_INTEGER, iDataKindID PLS_INTEGER, iMessageKindID PLS_INTEGER, iIsTestMessage PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает SQL-сценарий вида сведений для обработки результатов входящего сообщения.
Параметры:
- iDataKindRegionID, iDataKindID - ключ вида сведений;
- iMessageKindID - ID вида сообщения; константа из числа IMessageKindID_xxx;
- iIsTestMessage - признак тестового запроса (0/1);
- iStrict - определяет поведение, если сценарий такого вида отсутствует или пустой.
GetDataKindPrepOutMsgSQL
FUNCTION GetDataKindPrepOutMsgSQL(iDataKindRegionID PLS_INTEGER, iDataKindID PLS_INTEGER, iMessageKindID PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает SQL-сценарий вида сведений для подготовки исходящего сообщения.
Параметры:
- iDataKindRegionID, iDataKindID - ключ вида сведений;
- iMessageKindID - ID вида сообщения; константа из числа IMessageKindID_xxx;
- iStrict - определяет поведение, если сценарий такого вида отсутствует или пустой.
GetDataKindRefMessage
FUNCTION GetDataKindRefMessage(iDataKindRegionID PLS_INTEGER, iDataKindID PLS_INTEGER, sRefMessageCode VARCHAR2, iStrict PLS_INTEGER) RETURN CLOB;
Описание
Возвращает содержимое эталонного сообщения.
Параметры:
- iDataKindRegionID, iDataKindID - ключ вида сведений;
- sRefMessageCode - код эталонного сообщения;
- iStrict - определяет поведение при отсутствии вида сведений или эталонного ответа.
GetDataKindAttribName
FUNCTION GetDataKindAttribName(iRegionID PLS_INTEGER, iID PLS_INTEGER, iStrict PLS_INTEGER := 0, iDisplayMode PLS_INTEGER := 0) RETURN VARCHAR2;
Описание
Возвращает наименование атрибута вида сведений.
Параметры:
- iRegionID, iID - ключ атрибута;
- iStrict - определяет поведение при отсутствии атрибута;
- iDisplayMode - способ вывода результата, как для pkGen.FormatNameWithRKey.
GetDataKindAttribValue
FUNCTION GetDataKindAttribValue(iDataKindRegionID PLS_INTEGER, iDataKindID PLS_INTEGER, iAttribRegionID PLS_INTEGER, iAttribID PLS_INTEGER, iStrict PLS_INTEGER, iMaxValueLen PLS_INTEGER := NULL) RETURN VARCHAR2;
Описание
Возвращает значение атрибута вида сведений.
Параметры:
- iDataKindRegionID, iDataKindID - ключ вида сведений;
- iAttribRegionID, iAttribID - ключ атрибута;
- iStrict - определяет поведение при отсутствии вида сведений, атрибута или его значения;
- iMaxValueLen - максимальная допустимая длина значения атрибута; если null, длина значения не контролируется; если длина значения больше, то при iStrict=0 значение усекается, в противном случае возникает exception.
GetDataKindAttribValueInt
FUNCTION GetDataKindAttribValueInt(iDataKindRegionID PLS_INTEGER, iDataKindID PLS_INTEGER, iAttribRegionID PLS_INTEGER, iAttribID PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает значение атрибута вида сведений, приведённое к целому. Параметры аналогичны pkSMEV3.GetDataKindAttribValue.
GetDataKindAttribValueName
FUNCTION GetDataKindAttribValueName(iAttribRegionID PLS_INTEGER, iAttribID PLS_INTEGER, iValueID PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает наименование значения атрибута вида сведений по его ID.
Параметры:
- iAttribRegionID, iAttribID - ключ атрибута;
- iValueID - значение параметра.
Поддерживаются следующие типы данных:
- Logical;
- PickList;
- MultiPickList;
- LookupID;
- MultiLookupID.
Для остальных типов данных вызывается exception.
Если значение iValueID=null, для поддерживаемых типов данных возвращает null.
GetDataKindAttribValueName
FUNCTION GetDataKindAttribValueName(iAttribRegionID PLS_INTEGER, iAttribID PLS_INTEGER, VALUE uszn.TRgnKey, iRgnPrefixType PLS_INTEGER := 0) RETURN VARCHAR2;
Описание
Аналогична предыдущей, но используется для типа данных LookupRKey и MultiLookupRKey.
Дополнительный параметр:
- iRgnPrefixType - вид регионального префикса: 0 - отсутствует; 1 - есть только у районов, отличных от 0; 2 - есть у всех районов.
CheckDataKindPDocCompatibility
PROCEDURE CheckDataKindPDocCompatibility(iDataKindRegionID PLS_INTEGER, iDataKindID PLS_INTEGER, iPDocClassID PLS_INTEGER);
Описание
Проверяет совместимость класса персонального документа с видом сведений.
Если они несовместимы, возникает exception.
Параметры:
- iDataKindRegionID, iDataKindID - ключ вида сведений;
- iPDocClassID - ID класса персонального документа.
Если операция или документ не существует, возникает exception.
Привилегии на виды сведений
GetUserGroupDataKindPrivs
FUNCTION GetUserGroupDataKindPrivs(iUserGroupID PLS_INTEGER, iDataKindRgnID PLS_INTEGER, iDataKindID PLS_INTEGER, iIsPermission PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает привилегии группы пользователей на вид сведений.
Параметры:
- iUserGroupID - ID группы пользователей;
- iDataKindRgnID, iDataKindID - ключ вида сведений;
- iIsPermission - какой вид привилегий требуется получить: 0 - запрещение, 1 - разрешение.
Возвращает набор указанных привилегий в виде битовой маски. Если привилегии отсутствуют, возвращает 0.
SetUserGroupDataKindPrivs
PROCEDURE SetUserGroupDataKindPrivs(iUserGroupID PLS_INTEGER, iDataKindRgnID PLS_INTEGER, iDataKindID PLS_INTEGER, iPermittedPrivs PLS_INTEGER, iRestrictedPrivs PLS_INTEGER);
Описание
Устанавливает привилегии группы пользователей на вид сведений.
Параметры:
- iUserGroupID - ID группы пользователей;
- iDataKindRgnID, iDataKindID - ключ вида сведений;
- iPermittedPrivs - набор разрешений в виде битовой маски;
- iRestrictedPrivs - набор запрещений в виде битовой маски.
GetDataKindUserPrivs
FUNCTION GetDataKindUserPrivs(iDataKindRgnID PLS_INTEGER, iDataKindID PLS_INTEGER, sUserName VARCHAR2 := USER) RETURN PLS_INTEGER;
Описание
Возвращает привилегии указанного пользователя на вид сведений в виде битовой маски.
Параметры:
- iDataKindRgnID, iDataKindID - ключ вида сведений;
- sUserName - имя пользователя СУБД.
CheckDataKindPriv
PROCEDURE CheckDataKindPriv(iDataKindRgnID PLS_INTEGER, iDataKindID PLS_INTEGER, iPriv PLS_INTEGER);
Описание
Проверяет, что у текущего пользователя есть все указанные привилегии на вид сведений.
Параметры:
- iDataKindRgnID, iDataKindID - ключ вида сведений;
- iPriv - сумма битовых флагов проверяемых привилегий.
CheckInMsgDataKindPriv
PROCEDURE CheckInMsgDataKindPriv(iMessageID PLS_INTEGER, iPriv PLS_INTEGER);
Описание
Проверяет привилегии пользователя на вид сведений для входящего сообщения.
Параметры:
- iMessageID - ID входящего сообщения;
- iPriv - сумма битовых флагов проверяемых привилегий.
Если сообщение не существует или пользователь не имеет указанных привилегий, возникает exception.
CheckOutMsgDataKindPriv
PROCEDURE CheckOutMsgDataKindPriv(iRegionID PLS_INTEGER, iMessageID PLS_INTEGER, iPriv PLS_INTEGER);
Описание
Проверяет привилегии пользователя на вид сведений для исходящего сообщения.
Параметры:
- iRegionID, iMessageID - ключ исходящего сообщения;
- iPriv - сумма битовых флагов проверяемых привилегий.
Если сообщение не существует или пользователь не имеет указанных привилегий, возникает exception.
Работа с запросами и ответами
AllocateNewOutMessageID
FUNCTION AllocateNewOutMessageID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает новый ID записи исходящего сообщения в заданном районе.
AllocateNewOutMsgCallID
FUNCTION AllocateNewOutMsgCallID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает новый ID записи отправки исходящего сообщения в заданном районе.
AllocateNewOutMsgCallProcID
FUNCTION AllocateNewOutMsgCallProcID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает новый ID записи обработки результатов ответа на исходящее сообщение в заданном районе.
AllocateNewOutMsgFileID
FUNCTION AllocateNewOutMsgFileID(iRegionID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает новый ID записи файла вложения исходящего сообщения в заданном районе.
CheckInMessageExists
PROCEDURE CheckInMessageExists(iInMessageID PLS_INTEGER);
Описание
Проверяет, что входящее сообщение существует, и если это не так, вызывает exception.
Параметры:
- iInMessageID - ID входящего сообщения.
CheckOutMessageExists
PROCEDURE CheckOutMessageExists(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER);
Описание
Проверяет, что исходящее сообщение существует, и если это не так, вызывает exception.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения.
LockIncomingMessage
PROCEDURE LockIncomingMessage(iMessageID PLS_INTEGER);
Описание
Устанавливает эксклюзивную блокировку на входящее сообщение.
Параметры:
- iMessageID - ID сообщения.
Если сообщение не существует или заблокировано, возникает exception.
LockOutgoingMessage
PROCEDURE LockOutgoingMessage(iRegionID PLS_INTEGER, iMessageID PLS_INTEGER);
Описание
Устанавливает эксклюзивную блокировку на исходящее сообщение.
Параметры:
- iRegionID, iMessageID - ключ сообщения.
Если сообщение не существует или заблокировано, возникает exception.
MessageReceived
FUNCTION MessageReceived( iServiceRegionID PLS_INTEGER, sServiceName VARCHAR2, iMessageRegionID PLS_INTEGER, bMessageData BLOB, iIsSignatureValid PLS_INTEGER, iMessageID OUT PLS_INTEGER, rMessageID OUT RAW) RETURN PLS_INTEGER;
Описание
Сохраняет в БД входящее сообщение СМЭВ-3, полученное веб-сервисом.
Входные параметры:
- iServiceRegionID - ID района веб-сервиса;
- sServiceName - техническое наименование веб-сервиса (нечувствительное к регистру);
- iMessageRegionID - ID района, в который адресовано сообщение;
- bMessageData - содержимое сообщения СМЭВ;
- iIsSignatureValid - признак валидности цифровой подписи СМЭВ (0/1).
Выходные параметры:
- iMessageID - ID созданной записи принятого сообщения;
- rMessageID - GUID принятого сообщения.
Возвращает код результатов работы: константу из числа IMsgReceived_xxx.
Если при сохранении сообщения произошла фатальная ошибка, возникает exception.
GetIncMessageID
FUNCTION GetIncMessageID(rMessageGUID RAW, iStrict PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает ID входящего сообщения по его GUID.
Параметры:
- rMessageGUID - GUID сообщение;
- iStrict - определяет поведение при отсутствии указанного сообщения.
GetIncMessageGUID
FUNCTION GetIncMessageGUID(iInMessageID PLS_INTEGER, iStrict PLS_INTEGER) RETURN RAW;
Описание
Возвращает GUID входящего сообщения по его ID.
Параметры:
- iInMessageID - ID входящего сообщения;
- iStrict - определяет поведение при отсутствии указанного сообщения.
GetOutMessageKey
PROCEDURE GetOutMessageKey(rMessageGUID RAW, iSearchCalls PLS_INTEGER, iStrict PLS_INTEGER, iOutMsgRegionID OUT PLS_INTEGER, iOutMsgID OUT PLS_INTEGER);
Описание
Поиск ключа исходящего сообщения по его GUID.
Входные параметры:
- rMessageGUID - GUID исходящего сообщения.
- iSearchCalls - выполнять ли поиск по записям отправки сообщения, если сообщение с таким GUID не найдено (0/1); это даёт возможность найти сообщение, если оно отправлялось несколько раз и его GUID поменялся;
- iStrict - определяет поведение при отсутствии результатов.
Выходные параметры:
- iOutMsgRegionID, iOutMsgID - ключ исходящего сообщения.
GetIncMsgOrigMessageKey
PROCEDURE GetIncMsgOrigMessageKey(iInMessageID PLS_INTEGER, iOutMsgRegionID OUT PLS_INTEGER, iOutMsgID OUT PLS_INTEGER);
Описание
Поиск ключа исходящего сообщения по ID ответа на него.
Входные параметры:
- iInMessageID - ID входящего сообщения.
Выходные параметры:
- iOutMsgRegionID, iOutMsgID - ключ исходящего сообщения, ответом на которое является данное входящее сообщение.
Если входящее сообщение не существует или не является ответом на исходящее сообщение, возникает exception.
Если исходящее сообщение не найдено, возникает exception.
GetIncMsgFileID
FUNCTION GetIncMsgFileID(iInMessageID PLS_INTEGER, sFileName VARCHAR2, iStrictExists PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает ID файла входящего сообщения СМЭВ-3 по его имени.
Параметры:
- iInMessageID - ID входящего сообщения;
- sFileName - имя файла;
- iStrictExists - определяет поведение при отсутствии файла, а также при отсутствии сообщения с таким ID.
Поиск производится без учёта регистра.
При наличии нескольких файлов с таким именем возвращает индекс первого из них.
GetAttachmentIndex
FUNCTION GetAttachmentIndex(Attachments IN TAttachmentList, sID VARCHAR2, iStrictExists PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает индекс файла в списке вложений, переданных в составе сообщения.
Параметры:
- Attachments - список вложений, полученных в составе сообщения (MTOM-вложения);
- sID - ID искомого файла;
- iStrictExists - определяет поведение при отсутствии файла.
Поиск производится с учётом регистра.
Поскольку при передаче вложений в составе сообщения атрибут “Имя файла” не предусмотрен, поиск ведётся по ID.
При наличии нескольких файлов с таким ID (что, вообще говоря, является ошибкой, т. к. по требованию МР ID должен
быть уникальным), возвращает индекс первого из них.
GetOutMsgRequestPDocID
FUNCTION GetOutMsgRequestPDocID(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает ID документа с данными исходящего сообщения.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения;
Если исходящее сообщение не существует, возникает exception.
GetOutMsgIDForRequestPDoc
FUNCTION GetOutMsgIDForRequestPDoc(iRegionID PLS_INTEGER, iRequestPDocID PLS_INTEGER, iStrict PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает ID исходящего сообщения для документа с данными запроса.
Параметры:
- iRegionID, iRequestPDocID - ключ документа с данными запроса;
- iStrict - определяет поведение при отсутствии сообщения и при неоднозначном соответствии.
GetOutMsgWorkflowRecID
FUNCTION GetOutMsgWorkflowRecID(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает ID сценария обработки для исходящего сообщения.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения.
Если исходящее сообщение не существует, возникает exception.
GetOutMsgScheduledTime
FUNCTION GetOutMsgScheduledTime(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN DATE;
Описание
Возвращает дату и время предполагаемой отправки исходящего сообщения в СМЭВ.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения.
Если отправка сообщения не запланирована, возвращает null.
Если исходящее сообщение не существует, возникает exception.
SchedulePDocRequest
FUNCTION SchedulePDocRequest( iRegionID PLS_INTEGER, iRequestPDocID PLS_INTEGER, iOperationRegionID PLS_INTEGER, iOperationID PLS_INTEGER, iDataKindRegionID PLS_INTEGER, iDataKindID PLS_INTEGER, iSenderRegionID PLS_INTEGER, iSenderID PLS_INTEGER, iRecipientRegionID PLS_INTEGER, iRecipientID PLS_INTEGER, iAudOriginID PLS_INTEGER, sAudNotes VARCHAR2 := NULL, iWorkflowRecID PLS_INTEGER := NULL) RETURN PLS_INTEGER;
Описание
Создаёт и ставит в очередь на отправку запрос SendRequest на основе персонального документа.
Параметры:
- iRegionID, iRequestPDocID - ключ экземпляра персонального документа;
- iOperationRegionID, iOperationID - ключ операции веб-сервиса для отправки сообщения;
- iDataKindRegionID, iDataKindID - ключ вида сведений;
- iSenderRegionID, iSenderID - ключ отправителя запроса; если null, берётся отправитель по умолчанию из районных настроек экземпляра Системы;
- iRecipientRegionID, iRecipientID - ключ получателя запроса; если null, получатель запроса остаётся незаполненным;
- iAudOriginID - ID источника события для аудита по документу;
- sAudNotes - примечания для аудита по документу;
- iWorkflowRecID - ID записи сценария обработки; null, если сценарий обработки не используется.
Для подготовки данных запроса вызывается соответствующий SQL-сценарий вида сведений.
Возвращает ID записи исходящего сообщения.
Если пользователь не имеет необходимых привилегий на экземпляр персонального документа или на вид сведений,
возникает exception.
ScheduleCustomRequest
FUNCTION ScheduleCustomRequest( iRegionID PLS_INTEGER, iSmevVersionID PLS_INTEGER, DataKindKey uszn.TRgnKey, iSenderRegionID PLS_INTEGER, iSenderID PLS_INTEGER, iRecipientRegionID PLS_INTEGER, iRecipientID PLS_INTEGER, Request TSendRequestRequest, iWorkflowRecID PLS_INTEGER := NULL) RETURN PLS_INTEGER;
Описание
Создаёт и ставит в очередь на отправку запрос SendRequest без использования персонального документа.
Параметры:
- iRegionID - ID района сообщения;
- iSmevVersionID - ID версии СМЭВ; если null, используется версия СМЭВ по умолчанию;
- DataKindKey - ключ вида сведений;
- iSenderRegionID, iSenderID - ключ отправителя запроса; если null, берётся отправитель по умолчанию из районных настроек экземпляра Системы;
- iRecipientRegionID, iRecipientID - ключ получателя запроса; если null, получатель запроса остаётся незаполненным;
- Request - структурированные данные запроса.
- iWorkflowRecID - ID записи сценария обработки; null, если сценарий обработки не используется.
Возвращает ID записи исходящего сообщения.
Если Request.cContent не заполнен, для заполнения данных сообщения вызывается соответствующий SQL-сценарий вида
сведений.
Если пользователь не имеет необходимых привилегий на вид сведений, возникает exception.
ScheduleCustomResponse
FUNCTION ScheduleCustomResponse( iRegionID PLS_INTEGER, iSmevVersionID PLS_INTEGER, DataKindKey uszn.TRgnKey, iSenderRegionID PLS_INTEGER, iSenderID PLS_INTEGER, iRecipientRegionID PLS_INTEGER, iRecipientID PLS_INTEGER, rIncomingMessageGUID RAW, Response IN TSendResponseRequest, iWorkflowRecID PLS_INTEGER := NULL) RETURN PLS_INTEGER;
Описание
Response - структурированные данные ответа; iWorkflowRecID - ID записи сценария обработки; null, если сценарий обработки не используется. Возвращает ID записи исходящего сообщения. Если Response.cContent не заполнен, для заполнения данных сообщения вызывается соответствующий SQL-сценарий вида сведений. Если пользователь не имеет необходимых привилегий на вид сведений, возникает exception.
ScheduleRefTestRequest
FUNCTION ScheduleRefTestRequest( iRegionID PLS_INTEGER, iSmevVersionID PLS_INTEGER, DataKindKey uszn.TRgnKey, sMessageCode VARCHAR2, iSenderRegionID PLS_INTEGER, iSenderID PLS_INTEGER, iRecipientRegionID PLS_INTEGER, iRecipientID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Отправляет эталонный запрос.
Параметры:
- iRegionID - ID района сообщения;
- iSmevVersionID - ID версии СМЭВ; если null, используется версия СМЭВ по умолчанию;
- DataKindKey - ключ вида сведений;
- sMessageCode - код эталонного сообщения;
- iSenderRegionID, iSenderID - ключ отправителя;
- iRecipientRegionID, iRecipientID - ключ получателя.
Возвращает ID записи исходящего сообщения.
Если пользователь не имеет необходимых привилегий на вид сведений, возникает exception.
ScheduleRefTestResponse
FUNCTION ScheduleRefTestResponse( iRegionID PLS_INTEGER, iSmevVersionID PLS_INTEGER, DataKindKey uszn.TRgnKey, sMessageCode VARCHAR2, Request IN TGetRequestResponse) RETURN PLS_INTEGER;
Описание
Отправляет эталонный ответ на тестовый запрос.
Параметры:
- iRegionID - ID района сообщения;
- iSmevVersionID - ID версии СМЭВ; если null, используется версия СМЭВ по умолчанию;
- DataKindKey - ключ вида сведений;
- sMessageCode - код эталонного сообщения;
- Request - данные исходного запроса.
Возвращает ID записи исходящего сообщения.
Если пользователь не имеет необходимых привилегий на вид сведений, возникает exception.
ScheduleRequestRejected
FUNCTION ScheduleRequestRejected( iRegionID PLS_INTEGER, iSmevVersionID PLS_INTEGER, DataKindKey uszn.TRgnKey, Reasons IN TRejectReasonList, Request IN TGetRequestResponse) RETURN PLS_INTEGER;
Описание
Отправляет ответ, что запрос отклонён.
Параметры:
- iRegionID - ID района сообщения;
- iSmevVersionID - ID версии СМЭВ; если null, используется версия СМЭВ по умолчанию;
- DataKindKey - ключ вида сведений;
- Reasons - список причин отклонения запроса;
- Request - данные исходного запроса.
Возвращает ID записи исходящего сообщения.
Если пользователь не имеет необходимых привилегий на вид сведений, возникает exception.
ScheduleRequestUnknown
FUNCTION ScheduleRequestUnknown( iRegionID PLS_INTEGER, iSmevVersionID PLS_INTEGER, DataKindKey uszn.TRgnKey, Request IN TGetRequestResponse, sReasonDesc VARCHAR2 := 'Вид запроса не распознан') RETURN PLS_INTEGER;
Описание
Отправляет ответ, что запрос отклонён по причине неизвестного вида запроса.
Параметры:
- iRegionID - ID района сообщения;
- iSmevVersionID - ID версии СМЭВ; если null, используется версия СМЭВ по умолчанию;
- DataKindKey - ключ вида сведений;
- Request - данные исходного запроса.
Возвращает ID записи исходящего сообщения.
Если пользователь не имеет необходимых привилегий на вид сведений, возникает exception.
ScheduleNoData
FUNCTION ScheduleNoData( iRegionID PLS_INTEGER, iSmevVersionID PLS_INTEGER, DataKindKey uszn.TRgnKey, Request IN TGetRequestResponse, sReasonDesc VARCHAR2 := 'Данные не найдены') RETURN PLS_INTEGER;
Описание
Отправляет ответ, что запрос отклонён по причине отсутствия данных.
Параметры:
- iRegionID - ID района сообщения;
- iSmevVersionID - ID версии СМЭВ; если null, используется версия СМЭВ по умолчанию;
- DataKindKey - ключ вида сведений;
- Request - данные исходного запроса.
Возвращает ID записи исходящего сообщения.
Если пользователь не имеет необходимых привилегий на вид сведений, возникает exception.
ScheduleAccessDenied
FUNCTION ScheduleAccessDenied( iRegionID PLS_INTEGER, iSmevVersionID PLS_INTEGER, DataKindKey uszn.TRgnKey, Request IN TGetRequestResponse, sReasonDesc VARCHAR2 := 'Отказано в доступе') RETURN PLS_INTEGER;
Описание
Отправляет ответ, что запрос отклонён по причине отсутствия права на доступ к данным.
Параметры:
- iRegionID - ID района сообщения;
- iSmevVersionID - ID версии СМЭВ; если null, используется версия СМЭВ по умолчанию;
- DataKindKey - ключ вида сведений;
- Request - данные исходного запроса.
Возвращает ID записи исходящего сообщения.
Если пользователь не имеет необходимых привилегий на вид сведений, возникает exception.
OutMessageAddPersonalSig
PROCEDURE OutMessageAddPersonalSig(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER, cSignature CLOB);
Описание
Добавляет ЭП-СП для исходящего сообщения СМЭВ.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения СМЭВ;
- cSignature - тег <Signature> в кодировке Windows-1251.
Побочный эффект: содержимое таблицы r$_parsed_xml_data заменяется разобранным сообщением с добавленной ЭП-СП.
Если сообщение не содержит данных, не существует, заблокировано, не подлежит подписанию ЭП-СП или уже подписано,
либо пользователь не имеет необходимых привилегий, возникает exception.
ScheduleOutMessage
FUNCTION ScheduleOutMessage(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER, dSendTime DATE) RETURN DATE;
Описание
Ставит существующее исходящее сообщение в очередь на отправку в заданное время.
Возвращает предыдущее значение времени отправки.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения;
- dSendTime - желаемая дата и время отправки сообщения.
Если сообщение не содержит данных, не существует, заблокировано или пользователь не имеет необходимых привилегий,
возникает exception.
UnscheduleOutMessage
FUNCTION UnscheduleOutMessage(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN DATE;
Описание
Отменяет отправку исходящего сообщения в СМЭВ. Возвращает предыдущее значение предполагаемого времени отправки.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения.
Если исходящее сообщение не существует, заблокировано или пользователь не имеет необходимых привилегий,
возникает exception.
RepeatOutMsgCall
PROCEDURE RepeatOutMsgCall(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER, iMaxAttemptCount PLS_INTEGER, iReplyTimeLimit PLS_INTEGER);
Описание
Ставит исходящее сообщение в очередь на повторную отправку.
Выполняется только в том случае, если отправка сообщения ещё не запланирована, в противном случае заданное время
отправки остаётся без изменения.
Сообщение также не ставится в очередь на отправку, если попыток отправки ещё не было.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения;
- iMaxAttemptCount - максимальное разрешённое количество попыток (учитываются только успешно обработанные ответы); если null, ограничения на количество попыток нет;
- iReplyTimeLimit - время в минутах, отведённое на обработку сообщения; отсчитывается начиная с момента отправки первого сообщения, ответ на который был успешно обработан; если null, ограничения по времени обработки нет.
Если максимальное разрешённое количество попыток уже было выполнено или истекло время, отведённое на обработку,
возникает exception.
Если исходящее сообщение не существует или заблокировано, возникает exception.
RepeatFailedOutMsgCall
PROCEDURE RepeatFailedOutMsgCall(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER);
Описание
Ставит исходящее сообщение, последняя отправка которого завершилась неудачно, в очередь на повторную отправку.
Выполняется только в том случае, если отправка сообщения ещё не запланирована, в противном случае заданное время
отправки остаётся без изменения.
Сообщение также не ставится в очередь на повторную отправку, если неудачных попыток не было или последняя попытка
отправки была успешной.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения.
Если исходящее сообщение не существует или заблокировано, возникает exception.
GetInMsgToProcessIDs
FUNCTION GetInMsgToProcessIDs(iiRegionIDs uszn.TIntegerList, iMaxRecordCount PLS_INTEGER) RETURN uszn.TIntegerList;
Описание
Возвращает список ID входящих сообщений, подлежащих обработке.
Параметры:
- iiRegionIDs - список ID районов;
- iMaxRecordCount - максимальное допустимое количество записей, которое возвращает функция.
Возвращается список ID только тех сообщений, на обработку которых текущий пользователь имеет право.
GetCallToProcessKeys
FUNCTION GetCallToProcessKeys(iiRegionIDs uszn.TIntegerList, iMaxRecordCount PLS_INTEGER) RETURN uszn.TRgnKeyList;
Описание
Возвращает список ключей записей об отправке запроса, подлежащих обработке.
Параметры:
- iiRegionIDs - список ID рабочих районов;
- iMaxRecordCount - максимальное допустимое количество записей, которое возвращает функция.
Возвращается список ключей только тех записей, на обработку которых текущий пользователь имеет право.
ProcessInMessage
FUNCTION ProcessInMessage(iInMessageID PLS_INTEGER, iForce PLS_INTEGER, iAudOriginID PLS_INTEGER, sAudNotes VARCHAR2 := NULL) RETURN PLS_INTEGER;
Описание
Обрабатывает данные входящего сообщения.
Параметры:
- iInMessageID - ID входящего сообщения;
- iForce - обрабатывать ли сообщение независимо от того, обработано оно или нет (0/1);
- iAudOriginID - ID источника события для аудита по документу;
- sAudNotes - примечания для аудита по документу.
Если сообщение не существует, заблокировано или пользователь не имеет необходимых привилегий, возникает exception.
Возвращает ID записи с информацией об обработке.
SetInMsgIsCancelled
PROCEDURE SetInMsgIsCancelled(iInMessageID PLS_INTEGER, iValue PLS_INTEGER);
Описание
Устанавливает у входящего сообщения флаг is_cancelled.
Параметры:
- iInMessageID - ID входящего сообщения;
- iValue - значение флага (0/1).
Если сообщение не существует, заблокировано или пользователь не имеет необходимых привилегий, возникает exception.
Если флаг уже установлен, ничего не происходит.
ScheduleInMsgProcessing
PROCEDURE ScheduleInMsgProcessing(iInMessageID PLS_INTEGER);
Описание
Устанавливает/сбрасывает все необходимые флаги, чтобы входящее сообщение встало в очередь для обработки, в том
числе очищает статус ошибки.
Признак валидности ЭП СМЭВ сброшен быть не может, при попытке поставить в очередь для обработки сообщение с
невалидной ЭП СМЭВ возникает exception.
Параметры:
- iInMessageID - ID сообщения.
Если сообщение не существует, заблокировано или пользователь не имеет необходимых привилегий, возникает exception.
DeleteInMessage
PROCEDURE DeleteInMessage(iInMessageID PLS_INTEGER);
Описание
Удаляет входящее сообщение.
Параметры:
- iInMessageID - ID входящего сообщения;
Если сообщение не существует, заблокировано или пользователь не имеет необходимых привилегий, возникает exception.
DeleteOutMsgFile
PROCEDURE DeleteOutMsgFile(iRegionID PLS_INTEGER, iID PLS_INTEGER);
Описание
Удаляет файл исходящего сообщения СМЭВ. Если файл больше нигде не используется, он также удаляется.
Параметры:
- iRegionID, iID - ключ файла исходящего сообщения СМЭВ.
Если файл не существует или пользователь не имеет необходимых привилегий, возникает exception.
ProcessOutMsgResult
FUNCTION ProcessOutMsgResult(iRegionID PLS_INTEGER, iCallID PLS_INTEGER, iAudOriginID PLS_INTEGER, sAudNotes VARCHAR2 := NULL) RETURN PLS_INTEGER;
Описание
Обрабатывает результат отправки исходящего сообщения.
Параметры:
- iRegionID, iCallID - ключ записи об отправке сообщения;
- iAudOriginID - ID источника события для аудита по документу;
- sAudNotes - примечания для аудита по документу.
Возвращает ID записи с информацией об обработке.
Если сообщение не существует, не отправлялось в СМЭВ, заблокировано или пользователь не имеет необходимых
привилегий, возникает exception.
GetInMessageState
FUNCTION GetInMessageState(iInMessageID PLS_INTEGER, iCountProcessRecs PLS_INTEGER := 0) RETURN TInMessageState;
Описание
Возвращает состояние входящего сообщения.
Параметры:
- iInMessageID - ID входящего сообщения;
- iCountProcessRecs - выполнять ли подсчёт количества записей об обработке сообщения (0/1); если подсчёт не выполняется, iProcRecordCount будет содержать null.
Если входящее сообщение не существует, возникает exception.
GetInMsgProcessingState
FUNCTION GetInMsgProcessingState(iProcessingID PLS_INTEGER) RETURN uszn.pkSMEVCall.TCallProcessingState;
Описание
Возвращает состояние записи об обработке входящего сообщения, отправленного в СМЭВ.
Параметры:
- iProcessingID - ID записи об обработке входящего сообщения.
Если запись об обработке входящего сообщения не существует, возникает exception.
GetCallState
FUNCTION GetCallState(iRegionID PLS_INTEGER, iCallID PLS_INTEGER) RETURN uszn.pkSMEVCall.TCallState;
Описание
Возвращает состояние записи об отправке исходящего сообщения в СМЭВ.
Параметры:
- iRegionID, iCallID - ключ записи об отправке сообщения.
Если запись об отправке сообщения не существует, возникает exception.
GetCallProcessingState
FUNCTION GetCallProcessingState(iRegionID PLS_INTEGER, iCallProcessingID PLS_INTEGER) RETURN uszn.pkSMEVCall.TCallProcessingState;
Описание
Возвращает состояние записи об обработке исходящего сообщения, отправленного в СМЭВ.
Параметры:
- iRegionID, iCallProcessingID - ключ записи об обработке отправленного сообщения.
Если запись об обработке отправленного сообщения не существует, возникает exception.
GetCallOutMessageID
FUNCTION GetCallOutMessageID(iRegionID PLS_INTEGER, iCallID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает ID исходящего сообщения для записи о его отправке.
Параметры:
- iRegionID, iCallID - ключ записи об отправке исходящего сообщения.
Если запись не существует, возникает exception.
GetLastOutMsgCallID
FUNCTION GetLastOutMsgCallID(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает ID последней записи отправки исходящего сообщения в СМЭВ.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения.
Если сообщение ещё ни разу не отправлялось, возвращает null.
Если исходящее сообщение не существует, возникает exception.
GetFirstOutMsgSendTime
FUNCTION GetFirstOutMsgSendTime(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN DATE;
Описание
Возвращает дату и время первой попытки отправки исходящего сообщения в СМЭВ.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения.
Если попыток отправки не было, возвращает null.
Если исходящее сообщение не существует, возникает exception.
GetLastOutMsgSendTime
FUNCTION GetLastOutMsgSendTime(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN DATE;
Описание
Возвращает дату и время последней попытки отправки исходящего сообщения в СМЭВ.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения.
Если попыток отправки не было, возвращает null.
Если исходящее сообщение не существует, возникает exception.
GetLastFailedOutMsgCallCount
FUNCTION GetLastFailedOutMsgCallCount(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает количество произошедших подряд сбоев при отправке исходящего сообщения, начиная с последней отправки,
допускающих повторную отправку сообщения до достижения максимально допустимого количества сбоев.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения.
Если сообщение ещё ни разу не отправлялось, возвращает 0.
Если исходящее сообщение не существует, возникает exception.
GetFirstSuccOutMsgCallTime
FUNCTION GetFirstSuccOutMsgCallTime(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN DATE;
Описание
Возвращает дату и время первой отправки исходящего сообщения с успешно или частично успешно обработанным ответом.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения.
Если успешно обработанных попыток отправки не было, возвращает null.
Если исходящее сообщение не существует, возникает exception.
GetSuccOutMsgCallCount
FUNCTION GetSuccOutMsgCallCount(iRegionID PLS_INTEGER, iOutMessageID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает количество успешно или частично успешно обработанных ответов на исходящее сообщение.
Параметры:
- iRegionID, iOutMessageID - ключ исходящего сообщения.
Если сообщение ещё ни разу не отправлялось, возвращает 0.
Если исходящее сообщение не существует, возникает exception.
Разное
GetParticipantKeys
PROCEDURE GetParticipantKeys( MsgMetadata IN TMessageMetadata, iRegionID PLS_INTEGER, iStrictSender PLS_INTEGER, iStrictRecipient PLS_INTEGER, iSenderRegionID OUT PLS_INTEGER, iSenderID OUT PLS_INTEGER, iRecipientRegionID OUT PLS_INTEGER, iRecipientID OUT PLS_INTEGER); PRAGMA restrict_references(GetParticipantKeys, WNDS, WNPS); -- Получает ключ отправителя сообщения. -- Входные параметры: -- iRegionID, iMessageID - ключ исходящего сообщения. -- Выходные параметры: -- iSenderRegionID, iSenderID - ключ отправителя. -- Если исходящее сообщение не существует, возникает exception. PROCEDURE GetMessageSender(iRegionID PLS_INTEGER, iMessageID PLS_INTEGER, iSenderRegionID OUT PLS_INTEGER, iSenderID OUT PLS_INTEGER); PRAGMA restrict_references(GetMessageSender, WNDS, WNPS, RNPS); -- Получает ключ получателя сообщения. -- Входные параметры: -- iRegionID, iMessageID - ключ исходящего сообщения; -- iStrict - определяет поведение, если получатель не задан. -- Выходные параметры: -- iRecipientRegionID, iRecipientID - ключ получателя. -- Если исходящее сообщение не существует, возникает exception. PROCEDURE GetMessageRecipient(iRegionID PLS_INTEGER, iMessageID PLS_INTEGER, iRecipientRegionID OUT PLS_INTEGER, iRecipientID OUT PLS_INTEGER, iStrict PLS_INTEGER); PRAGMA restrict_references(GetMessageRecipient, WNDS, WNPS, RNPS);
Описание
Извлекает из маршрутных данных ключи отправителя и получателя запроса.
Входные параметры:
- MsgMetadata - метаданные сообщения, содержащие сведения об участниках взаимодействия;
- iRegionID - район, для которого потребуются ключи;
- iStrictSender - требуется ли обязательное успешное получение ключа отправителя (0/1);
- iStrictRecipient - требуется ли обязательное успешное получение ключа получателя (0/1).
Выходные параметры:
- iSenderRegionID, iSenderID - ключ отправителя;
- iRecipientRegionID, iRecipientID - ключ получателя.
GetMessageSender
PROCEDURE GetMessageSender(iRegionID PLS_INTEGER, iMessageID PLS_INTEGER, iSenderRegionID OUT PLS_INTEGER, iSenderID OUT PLS_INTEGER);
Описание
Получает ключ отправителя сообщения.
Входные параметры:
- iRegionID, iMessageID - ключ исходящего сообщения.
Выходные параметры:
- iSenderRegionID, iSenderID - ключ отправителя.
Если исходящее сообщение не существует, возникает exception.
GetMessageRecipient
PROCEDURE GetMessageRecipient(iRegionID PLS_INTEGER, iMessageID PLS_INTEGER, iRecipientRegionID OUT PLS_INTEGER, iRecipientID OUT PLS_INTEGER, iStrict PLS_INTEGER);
Описание
Получает ключ получателя сообщения.
Входные параметры:
- iRegionID, iMessageID - ключ исходящего сообщения;
- iStrict - определяет поведение, если получатель не задан.
Выходные параметры:
- iRecipientRegionID, iRecipientID - ключ получателя.
Если исходящее сообщение не существует, возникает exception.
GetRoutingCode
FUNCTION GetRoutingCode(iParticipantRgnID PLS_INTEGER, iParticipantID PLS_INTEGER, iStrict PLS_INTEGER) RETURN VARCHAR2;
Описание
Возвращает код маршрутизации участника взаимодействия в СМЭВ-3 для табличной маршрутизации.
Параметры:
- iParticipantRgnID, iParticipantID - ключ участника взаимодействия;
- iStrict - определяет поведение при отсутствии участника, а также при отсутствии у него кода маршрутизации.
IsDKProvider
FUNCTION IsDKProvider(iParticipantRgnID PLS_INTEGER, iParticipantID PLS_INTEGER, iDataKindRgnID PLS_INTEGER, iDataKindID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает, является ли участник взаимодействия поставщиком вида сведений (0/1).
Параметры:
- iParticipantRgnID, iParticipantID - ключ участника взаимодействия;
- iDataKindRgnID, iDataKindID - ключ вида сведений.
Если участник взаимодействия или вид сведений не существуют, возвращает 0.
IsDKConsumer
FUNCTION IsDKConsumer(iParticipantRgnID PLS_INTEGER, iParticipantID PLS_INTEGER, iDataKindRgnID PLS_INTEGER, iDataKindID PLS_INTEGER) RETURN PLS_INTEGER;
Описание
Возвращает, является ли участник взаимодействия потребителем вида сведений (0/1).
Параметры:
- iParticipantRgnID, iParticipantID - ключ участника взаимодействия;
- iDataKindRgnID, iDataKindID - ключ вида сведений.
Если участник взаимодействия или вид сведений не существуют, возвращает 0.
CheckIsDKProvider
PROCEDURE CheckIsDKProvider(iParticipantRgnID PLS_INTEGER, iParticipantID PLS_INTEGER, iDataKindRgnID PLS_INTEGER, iDataKindID PLS_INTEGER);
Описание
Проверяет, является ли участник взаимодействия поставщиком вида сведений, и если нет, возникает exception.
Параметры:
- iParticipantRgnID, iParticipantID - ключ участника взаимодействия;
- iDataKindRgnID, iDataKindID - ключ вида сведений.
Если участник взаимодействия или вид сведений не существуют, возникает exception.
CheckIsDKConsumer
PROCEDURE CheckIsDKConsumer(iParticipantRgnID PLS_INTEGER, iParticipantID PLS_INTEGER, iDataKindRgnID PLS_INTEGER, iDataKindID PLS_INTEGER);
Описание
Проверяет, является ли участник взаимодействия потребителем вида сведений, и если нет, возникает exception.
Параметры:
- iParticipantRgnID, iParticipantID - ключ участника взаимодействия;
- iDataKindRgnID, iDataKindID - ключ вида сведений.
Если участник взаимодействия или вид сведений не существуют, возникает exception.
GetAsyncProcStatusDesc
Описание
Возвращает описание статуса асинхронной обработки.
GetRequestRejectedDesc
Описание
Возвращает описание причины отказа.