Система информирования клиентов по электронной почте. e-Reporter (стр. 5 )

Function ShowOptions_RS(ByRef rs As ADODB. Recordset, ByVal OnlyView As Boolean) As Boolean

Функция отображает текущие настройки программы, переданные записью в параметре RS. Параметр OnlyView запрещает любые изменения и сохранение настроек.

Function InsertReport(ClientID As Long, DATE1 As Variant, DATE2 As Variant, SendAfter As Variant, ReportType As String, ReportSubj As String, ReportText As String, ReportTextHTML As String, SILENT As Boolean) As Boolean

Функция осуществляет добавление документа для отправки клиенту. Идентификатор клиента передается в параметре ClientID. Период, отражаемый отчетом, задается датами DATE1 и DATE2. Тип отчета (до 10 символов) передается в параметре ReportType, ReportSubj – содержит тему отправляемого письма. ReportText и ReportTextHTML - содержание письма в текстовом виде и в виде html соответственно. При задании параметра SendAfter письмо будет отправлено, только после указанной даты и времени при передаче пустого значения письмо будет отправлено при первой возможности. Параметр SILENT определяет, допустим ли какой-либо диалог с пользователем при выполнении функции.

При формировании документов для отправки обязательно задавайте параметр ReportType обозначающий тип документа, параметр DATE1 – первоначальная дата, относящаяся к документу. Возможно указание параметра DATE2 – конечная дата.

При добавлении нового документа система всегда проверяет три параметра DATE1, DATE2, REPORTYPE. И если оказывается, что уже ожидает отправку (но еще не отправлен) документ с совпадающими значениями этих полей, то старый документ, будет заменен на новый и клиенту не будут отправлены устаревшие данные.

Function GetAccountTemplate(SILENT As Boolean)As ADODB. Recordset

Функция создает и возвращает пустой объект Recordset содержащий структуру таблицы CLIENT_ACCOUNT.

Function AddAccountTemplate(rs As ADODB. Recordset, AccountNo As String, AccountVal As String, AccountName As String, SILENT As Boolean) As Boolean

Функция вносит новые данные в объект RS содержащий, структуру таблицы CLIENT_ACCOUNT. Объект RS может быть получен, например вызовом функции GetAccountTemplate.

Function UpdateClients(BankID As String, RS_ACCT As ADODB. Recordset, CLIENT_NAME As String, SILENT As Boolean, DELETED As Boolean, OnlyView As Boolean) As Boolean

Функция обновляет информацию о клиенте и его счетах. Клиент идентифицируется по идентификатору BankID. Объект RS_ACCT содержит список всех открытых счетов клиента. CLIENT_NAME – наименование клиента. Установленный в TRUE параметр DELETED вызывает установку статуса клиента на DELETED.

Обратите внимание, что в функцию передается банковский код идентификации BankID (строка), а не код в системе e-Reporter (int).

Имейте в виду, что если в базе e-Reporter содержится несколько записей для клиента с кодом BankID, то будут обновлены все эти записи.

Данная процедура является основной для выполнения синхронизации информации о клиенте с системой e-Reporter. Следует иметь ввиду, что при выполнении синхронизации в объекте RS_ACCT передаются открытые счета клиента. При этом, система e-Reporter в собственной базе:

·  добавляет те счета, которых нет в базе e-Reporter, но которые были переданы в функцию UpdateClients. Статусы у вновь добавленных счетов устанавливаются NEW(STOPPED);

·  счета, которые были заведены в системе e-Reporter, но информация о них не передана в функцию UpdateClients, считаются удаленными и их статусы устанавливаются на DELETED;

·  по остальным счетам, может быть изменена информация, например о наименовании, если в функцию UpdateClients передано другое наименование счета, т. о. будет выполнено обновление счетов;

·  правила смены статусов

	Новый статус	NEW	ACTIVE	STOPPED	DELETE
Старый статус
NEW		+			Если был удален
ACTIVE			+		Если был удален
STOPPED				+	Если был удален
DELETED		создан новый			+

Function DeleteClients(BankID As String, SILENT As Boolean) As Boolean

Функция устанавливает статус DELETED у клиента с кодом BankID.

Обратите внимание, что в функцию передается банковский код идентификации BankID (строка), а не код в системе e-Reporter (int).

Имейте в виду, что если в базе e-Reporter содержится несколько записей для клиента с кодом BankID, то будут обновлены все эти записи.

Function DuplicateClient_RS(rs As ADODB. Recordset, SILENT As Boolean) As Long

Функция создает новую запись о клиенте путем копирования информации из текущей записи RS. Функция возвращает код вновь созданного клиента ClientID или -1 в случае ошибки.

SetClientDefaults(rs As ADODB. Recordset)

Метод устанавливает значения по умолчанию для текущей записи в rs содержащей данные таблицы CLIENT.

SetAccountDefaults(rs As ADODB. Recordset)

Метод устанавливает значения по умолчанию для текущей записи в rs содержащей данные таблицы CLIENT_ACCOUNT.

Function GetDB() As REPORTGATE. DB

Функция возвращает ссылку на объект класса DB. Данная ссылка может быть использована для программирования работы с базой e-Reporter на более низком уровне.

ShowAbout()

Метод отображает окно «О программе» с текущей версией программы.

Все функции, если это специально не оговорено, возвращают значение типа Boolean, TRUE - означает успешное выполнение, FALSE – ошибка. В случае ошибки текст ошибки содержится в свойстве LastError.

Во многих функциях и методах используется параметр SILENT, установка данного параметра в TRUE запрещает любое взаимодействие с пользователем, в том числе и вывод сообщений об ошибках. Установка значения в FALSE позволяет отображать на экране сообщения об ошибках, а так же подтверждать действия системы у пользователя.

При работе с параметрами клиента, система оперирует двумя идентификаторами. Один - идентификатор системы e-Reporter описан в базе как ClientID с типом INT, данный идентификатор уникальный для каждой записи таблицы CLIENT. Другой – банковский идентификатор – это идентификатор клиента в банковской системе. Этот идентификатор описан в базе как BankClientID, имеет тип VARCHAR(30) и позволяет связать базу e-Reporter с банковской системой.

3.2.3  Класс DB

Данный класс предоставляет расширенную низкоуровневую функциональность базы данных для работы системы e-Reporter.

Function GetRS_Clients(ByRef rs As ADODB. Recordset, Optional ReadOnly As Boolean = False, Optional STATUS As Integer = -1) As Boolean

Функция возвращает в параметре RS открытый объект Recordset, содержащий данные из таблицы CLIENT о клиентах со статусом STATUS. Свойство ReadOnly возвращает Recordset, открытый только для чтения. В случае ошибки функция возвращает значение false.

Function GetRS_Client(ByRef rs As ADODB. Recordset, ByVal ClientID As Long, BankID As String, IgnoreNotFound As Boolean, ReadOnly As Boolean) As Boolean

Функция возвращает в параметре RS открытый объект Recordset, содержащий данные из таблицы CLIENT для клиента с идентификатором ClientID или BankID. Свойство ReadOnly возвращает Recordset, открытый только для чтения. Параметр IgnoreNotFound блокирует вывод с сообщение об ошибке, если клиента с данным идентификатором не найдено. В случае ошибки функция возвращает значение false.

Function GetRS_Account(rs As ADODB. Recordset, ClientID As Long, STATUS As Long, ReadOnly As Boolean, Optional ID As Long = -1, Optional CLIENTCURSOR As Boolean = False) As Boolean

Функция возвращает в параметре RS открытый объект Recordset, содержащий данные о счетах из таблицы CLIENT_ACCOUNT для клиента с идентификатором ClientID и со статусом счетов равным STATUS. Свойство ReadOnly возвращает Recordset, открытый только для чтения. Если задан параметр ID, то возвращается Recordset с информацией о счете с идентификатором ID. Параметр CLIENTCURSOR указывает на необходимость создания клиентского курсора. В случае ошибки в функции возвращается значение false.

Function GetRS_Report(rs As ADODB. Recordset, ClientID As Long, Optional ReadOnly As Boolean = True, Optional ReportID As Long = -1) As Boolean

Функция возвращает в параметре RS открытый объект Recordset, содержащий данные о документах из таблицы CLIENT_REPORT для клиента с идентификатором ClientID. Свойство ReadOnly возвращает Recordset, открытый только для чтения. Если задан параметр ReportID, то возвращается Recordset с информацией о конкретном документе с идентификатором ID. В случае ошибки в функции возвращается значение false.

Function GetRS_ReportsWait(rs As ADODB. Recordset, MAXCOUNT As Long) As Boolean

Функция возвращает в параметре RS открытый объект Recordset, содержащий данные об документах ожидающих отправку на данный момент. Параметр MAXCOUNT определяет максимальное число попыток отправки документа, после которого прекращаются попытки отправки документа. Документы число попыток отправок которых меньше MAXCOUNT попадут в результирующий RS, у которых больше не попадут. В случае ошибки в функции возвращается значение false.

Function DeleteOldReports(day As Long, MAXCOUNT As Long) As Long

Функция удаляет из базы документы старше DAY дней успешно отправленные или число неудачных попыток отправок превысило MAXCOUNT. Функция возвращает число удаленных записей.

Del_Client(ClientID As Long)

Функция удаляет из базы информацию о клиенте с кодом ClientID.

Del_Account(AccountID As Long)

Функция удаляет из базы информацию о счете с кодом AccountID.

Del_Report(ReportID As Long)

Функция удаляет из базы информацию о документе с кодом ReportID.

3.3  Пример интеграции с RS-BANK.

Поставляемая система комплектуется макросами для работы с системой RS-BANK. Макросы находятся в директории RS-BANK дистрибутивного диска.

send_reports. mac	Макрос рассылки выписок
upd_clients. mac	Макрос обновления информации и клиенте

3.3.1  Обновление базы клиентов и счетов.

3.3.2  Формирование выписок по счетам.

Наименования DATAHOUSE, E-REPORTER, упомянутые в данном документе являются товарными знаками, принадлежащими компании .

Microsoft, Windows, Windows NT, SQL Server, Access, MSDE и/или иные продукты Microsoft, упомянутые в данном документе, являются либо товарными знаками, либо зарегистрированными товарными знаками Microsoft. Названия других продуктов и компаний, упомянутые здесь, могут являться товарными знаками соответствующих владельцев. Упомянутые в примерах компании, имена людей, организаций, продукты и другие данные являются вымышленными и не имеют никакого отношения к реальным компаниям, личностям, организациям, продуктам и другим персональным данным.

Microsoft, Windows, Windows NT, SQL Server, MS Access, MSDE and/or other Microsoft products referenced herein are either registered trademarks or trademarks of Microsoft Corporation in the U. S. and/or other countries. The names of actual companies and products mentioned herein may be the trademarks of their respective owners. The example companies, organizations, products, domain names, email addresses, logos, people and events depicted herein are fictitious. No association with any real company, organization, product, domain name, e-mail address, logo, person, or event is intended or should be inferred.