Техническая спецификация (стр. 2 )

4  Функциональная спецификация

Обмен данными между ДБО и АБС осуществляется с помощью текстовых файлов, в которых в определенном формате представлена информация о документе.

4.1  Функции для работы с OLE-сервером

4.1.1  Функции общего назначения

Вход в систему

long LoginEx(LPCTSTR parUserName, LPCTSTR parPassword, LPCTSTR parDBName)

Назначение	Параметры	Описание параметра	Возвращаемые значения
Функция осуществляет аутентификацию пользователя для работы с системой. Должна быть вызвана сразу после регистрации OLE-сервера в вызывающей программе.	parUserName	имя пользователя для входа систему	Код ошибки. При успешном завершении возвращается значение 0x. В случае неуспеха – любое другое число, которое и является кодом ошибки
parPassword	пароль пользователя для входа в систему
parDBName	имя базы данных, в которой будет осуществляться работа

Выход из системы

void ShutdownBOleSrv()

Назначение	Параметры	Описание параметра	Возвращаемые значения
Функция завершает работу программы.			Void

Получение кода ошибки

long TripError()

Назначение	Параметры	Описание параметра	Возвращаемые значения
Функция возвращает код ошибки, возникшей при выполнении последней операции в DiasoftBank 4x4 WF.			Код ошибки. При успешном завершении возвращается значение 0x. В случае неуспеха – любое другое число, которое и является кодом ошибки.

Получение описания ошибки

BSTR TripErrorText()

Назначение	Параметры	Описание параметра	Возвращаемые значения
Функция возвращает текстовое описание ошибки, возникшей при выполнении предыдущей операции.			Имеет формат EEEEEEEEEEsssssssssssssssssssssss, где EEEEEEEEEE – код ошибки выполнения функции TripErrorText; ssssssssssssssssssssssssss – текстовое описание ошибки.

4.1.2  Передача данных в систему

Начать передачу Рейса.

long StartTrip(LPCTSTR pstrAbonentName, LPCTSTR pstrTripID)

Назначение	Параметры	Описание параметра	Возвращаемые значения
Функция инициализирует передачу одного Рейса для заданного Абонента	pstrAbonentName	сокращенное наименование Абонента	Код ошибки. При успешном завершении возвращается значение 0x. В случае неуспеха – любое другое число, которое и является кодом ошибки.
pstrTripID	номер Рейса, каждый Рейс должен иметь уникальный номер в пределах одного Абонента

Передать очередную строку Рейса.

long PutTripString(LPCTSTR pstrTripString)

Назначение	Параметры	Описание параметра	Возвращаемые значения
Функция передает в систему очередную строку Рейса	pstrTripString	очередная строка Рейса. Не должна содержать символов перевода строки и возврата каретки	Код ошибки. При успешном завершении возвращается значение 0x. В случае неуспеха – любое другое число, которое и является кодом ошибки.

Завершить передачу Рейса.

long AcceptTrip()

Назначение	Параметры	Описание параметра	Возвращаемые значения
Функция завершает передачу Рейса. При вызове данной функции происходит фактическая обработка Рейса в DiasoftBANK 4x4 WF. По результатам обработки возвращается ошибка.			Код ошибки. При успешном завершении возвращается значение 0x. В случае неуспеха – любое другое число, которое и является кодом ошибки.

Прервать передачу Рейса.

long RejectTrip()

Назначение	Параметры	Описание параметра	Возвращаемые значения
Функция прекращает передачу Рейса. Ранее принятые данные не обрабатываются.			Код ошибки. При успешном завершении возвращается значение 0x. В случае неуспеха – любое другое число, которое и является кодом ошибки.

4.1.3  Прием данных из системы

Запросить список ответных Рейсов

BSTR GetReplyList(LPCTSTR pstrAbonentName)

Назначение	Параметры	Описание параметра	Возвращаемые значения
Функция возвращет список ответных Рейсов, которые ожидают передачи удаленному Абоненту. Список может содержать один Рейс, несколько Рейсов, не содержать ни одного Рейса.	pstrAbonentName	сокращенное наименование Абонента	Имеет формат EEEEEEEEEErrrrrr1,rrrrr2,…..,rrrrrrN, где EEEEEEEEEE – код ошибки выполнения функции GetReplyList; rrrrrr1,….,rrrrrN – список номеров ответных Рейсов в десятичном формате, разделенные запятыми. Если для Абонента нет ни одного ответного Рейса поля rrrrrr1,….,rrrrrN отсутствуют в возвращаемом значении.

Подготовить содержимое ответного Рейса

BSTR PrepareReply(LPCTSTR pstrAbonentName, LPCTSTR pstrTripNumber)

Назначение	Параметры	Описание параметра	Возвращаемые значения
Функция выполняет подготовку заданного ответного Рейса для передачи его Абоненту. После подготовки Рейса можно приступать к приему данных из DiasoftBANK 4x4 WF.	pstrAbonentName	сокращенное наименование Абонента	Имеет формат EEEEEEEEEEnnnnnnnnn где EEEEEEEEEE – код ошибки выполнения функции PrepareReply; nnnnnnnnnnn – размер ответного Рейса в байтах.
pstrTripNumber	номер Рейса, полученный как результат вызова функции GetReplyList

Принять очередную строку ответного Рейса

BSTR GetReplyString()

Назначение	Параметры	Описание параметра	Возвращаемые значения
Функция возвращает очередную строку ответного Рейса.			Имеет формат EEEEEEEEEEsssssssssssssssssssssssssss где EEEEEEEEEE – код ошибки выполнения функции GetReplyString; sssssssssssssssssssssss – очередная строка данных ответного Рейса. Получение пустой строки означает окончание данных в принимаемом Рейсе.

Подтвердить прием ответного Рейса

long ReplyTransferred()

Назначение	Параметры	Описание параметра	Возвращаемые значения
Функция подтверждает успешний прием Рейса на строне Абонента. Рейс, который был успешно принят более не передается. При выполнении операции подтверждения в DiasoftBank 4x4 WF выполняется операция по изменению состояния этого Рейса. По результатм выполнения перехода возвращается код ошибки.			Код ошибки. При успешном завершении возвращается значение 0x. В случае неуспеха – любое другое число, которое и является кодом ошибки.

Прекратить прием ответного Рейса

long ReplyRejected()

Назначение	Параметры	Описание параметра	Возвращаемые значения
Функция отменяет прием ответного Рейса. Никаких действий в DiasoftBank 4x4 WF не производится.			Код ошибки. При успешном завершении возвращается значение 0x. В случае неуспеха – любое другое число, которое и является кодом ошибки.

4.2  Формат файла, формируемого системой "Удаленный клиент" (запрос клиента)

Файл запроса клиента представляет собой текстовый файл (в кодах ASCII),

строки которого должны заканчиваться символами h010, h013 ("Конец строки",

"Перевод каретки").

Структура заголовка запроса приведена ниже:

Позиция	Обозначение
1-8	Имя клиента для входа в систему DiasoftBANK (8 символов).
9	Пробел (1 символ).
10-21	Пароль клиента для входа в систему DiasoftBANK (12 символов). Если пароль меньше 12 символов, то оставшиеся символы заполняются пробелами.
22	Пробел (1 символ).
23-30	Начальная дата получения выписки (8 символов в формате ДД/ММ/ГГ).
31	Пробел (1 символ).
32	Тип запроса (1 символ).Символ с кодом h001 - передача документов клиента;Символ с кодом h002 - запрос на получение выписки;Символ с кодом. h003 - передача документов и запрос на получение выписки.
33	Признак версии (символ #)
34-41	Конечная дата получения выписки (8 символов в формате ДД/ММ/ГГ)
42	Пробел (если курсы валют не запрашиваются, то этот и все последующие символы отсутствуют)
43	Символ с кодом hсимвол) - признак запроса курса.
44	Пробел
45-52	Начальная дата для получения курсов
53	Пробел
54-61	Конечная дата для получения выписки курсов

Далее идет конструкция (со следующей строки):