История страницы

Типы сообщения настраиваются в конфигурации, одна или несколько записей вида:

Блок кода

language	ruby
linenumbers	false

messageType.<id>.title=<title>
messageType.<id>.class=<messageTypeClassName>

Где:

<id> - уникальный числовой идентификатор типа сообщения, не должен меняться впоследствии;
<title> - наименование типа сообщения;
<messageTypeClassName> - имя класса-обработчика сообщений.

Остальные параметры различаются для разных видов сообщений.

Для типа сообщения могут быть указаны один или несколько режимов поиска :

Блок кода

language	ruby
linenumbers	false

messageType.<id>.search.<searchModeId>.title=<title>
messageType.<id>.search.<searchModeId>.class=<searchModeClassName>

Где:

<searchModeId> - уникальный числовой идентификатор режима поиска, начиная с 1;
<title> - наименование режима поиска;
<searchModeclassName> - имя класса, реализующего режим поиска.

Первый режим поиска применяется по-умолчанию при открытии сообщения для обработки.

Необязателен к указанию и класс, сохраняющий контакт.

Блок кода

language	ruby
linenumbers	false

messageType.<id>.saver.class=<saverClassName>

На скриншоте цифрой 1 изображены режимы поиска, 2 - режимы сохранения контакта.

Режимы поиска и сохранения могут быть специфичны для типа сообщения.

Режимы поиска

Таблица. Режимы поиска

Значение <searchModeClassName>

Что ищет

Конфигурация и пример

ru.bgcrm.dao.message.MessageTypeSearchCustomerByTitle

Контрагента по наименованию, для любого типа сообщения.

Нет дополнительных параметров.

Пример:

Блок кода

language	ruby
linenumbers	false

messageType.1.search.2.title=Контрагент по названию
messageType.1.search.2.class=ru.bgcrm.dao.message.MessageTypeSearchCustomerByTitle

ru.bgcrm.dao.message.MessageTypeSearchEmail

Поиск контрагента по Email для типа сообщения Email.

Нет дополнительных параметров.

Пример:

Блок кода

language	ruby
linenumbers	false

messageType.1.search.1.title=Авто по EMail
messageType.1.search.1.class=ru.bgcrm.dao.message.MessageTypeSearchEmail

ru.bgcrm.dao.message.MessageTypeSearchCall

Поиск контрагента в базе BGCRM по номеру телефона звонящего для типа сообщения Call. Поиск производится по точному совпадению.

Блок кода

language	java
linenumbers	false

messageType.<id>.search.<searchModeId>.title=<title>
messageType.<id>.search.<searchModeId>.class=ru.bgcrm.dao.message.MessageTypeSearchCall
messageType.<id>.search.<searchModeId>.commands=<commands>
# необязательный параметр
messageType.<id>.search.<searchModeId>.stringExpressionNumberPreprocess=<jexl>

Где:

<commands> - команды, в данный момент поддержана customerByPhoneParam:<paramId>, где <paramId> - идентификатор параметра типа "телефон" в биллинге;
<jexl> - JEXL выражение для предобработки номера перед поиском с его использованием, исходный номер передаётся переменной numberFrom.

Пример:

Блок кода

language	ruby
linenumbers	false

messageType.1.search.1.title=Авто контрагент (номер)
messageType.1.search.1.class=ru.bgcrm.dao.message.MessageTypeSearchCall
messageType.1.search.1.commands=customerByPhoneParam:10
messageType.1.search.1.stringExpressionNumberPreprocess=if( numberFrom.length() == 11 ){ numberFrom = numberFrom.substring(1)}; return numberFrom;

ru.bgcrm.plugin.bgbilling.dao.MessageTypeSearchEmail

Поиск договора в базе BGBilling по EMail парамеру для типа сообщения EMail.

Блок кода

language	ruby
linenumbers	false

messageType.<id>.search.<searchModeId>.title=<title>
messageType.<id>.search.<searchModeId>.class=ru.bgcrm.plugin.bgbilling.dao.MessageTypeSearchEmail
messageType.<id>.search.<searchModeId>.billingId=<billingId>
messageType.<id>.search.<searchModeId>.paramIds=<paramIds>

Где:

<billingId> - идентификатор биллинга;
<paramIds> - коды параметров договора т ипа EMail через запятую.

Пример:

Блок кода

language	ruby
linenumbers	false

messageType.1.search.3.title=Договор по параметру EMail
messageType.1.search.3.class=ru.bgcrm.plugin.bgbilling.dao.MessageTypeSearchEmail
messageType.1.search.3.billingId=bitel
messageType.1.search.3.paramIds=7

ru.bgcrm.plugin.bgbilling.dao.MessageTypeSearchCall

Поиск договора в базе BGBilling по номеру телефона звонящего для типа сообщения Call. Поиск производится по подстроке.

Блок кода

language	java
linenumbers	false

messageType.<id>.search.<searchModeId>.title=<title>
messageType.<id>.search.<searchModeId>.class=ru.bgcrm.plugin.bgbilling.dao.MessageTypeSearchCall
messageType.<id>.search.<searchModeId>.billingId=<billingId>
messageType.<id>.search.<searchModeId>.commands=<commands>
# необязательный параметр
messageType.<id>.search.<searchModeId>.stringExpressionNumberPreprocess=<jexl>

Где:

<billingId> - идентификатор биллинга;
<commands> - команды, в данный момент поддержана contractByPhoneParam:<paramId>, где <paramId> - идентификатор параметра типа "телефон" в биллинге;
<jexl> - JEXL выражение для предобработки номера перед поиском с его использованием, исходный номер передаётся переменной numberFrom.

Пример:

Блок кода

language	java
linenumbers	false

messageType.1.search.1.title=Авто (номер)
messageType.1.search.1.class=ru.bgcrm.plugin.bgbilling.dao.MessageTypeSearchCall
messageType.1.search.1.billingId=bg
messageType.1.search.1.commands=contractByPhoneParam:27
messageType.1.search.1.stringExpressionNumberPreprocess=if( numberFrom.length() == 11 ){ numberFrom = numberFrom.substring(1)}; return numberFrom;

ru.bgcrm.plugin.bgbilling.dao.MessageTypeSearchContractByTitleAndComment

Поиск договора в базе BGBilling по номеру и комментарию, для любого типа сообщения.

Блок кода

language	ruby
linenumbers	false

messageType.<id>.search.<searchModeId>.title=<title>
messageType.<id>.search.<searchModeId>.class=ru.bgcrm.plugin.bgbilling.dao.MessageTypeSearchContractByTitleAndComment
messageType.<id>.search.<searchModeId>.billingId=<billingId>

Где:

<billingId> - идентификатор биллинга.

Пример:

Блок кода

language	ruby
linenumbers	false

messageType.1.search.2.title=По номеру/примечанию
messageType.1.search.2.class=ru.bgcrm.plugin.bgbilling.dao.MessageTypeSearchContractByTitleAndComment
messageType.1.search.2.billingId=bg

ru.bgcrm.plugin.bgbilling.dao.MessageTypeSearchContractByDialUpLogin

Поиск договора в базе BGBilling по логину либо алиасу DialUp модуля.

Блок кода

language	ruby
linenumbers	false

messageType.<id>.search.<searchModeId>.title=<title>
messageType.<id>.search.<searchModeId>.class=ru.bgcrm.plugin.bgbilling.dao.MessageTypeSearchContractByDialUpLogin
messageType.<id>.search.<searchModeId>.billingId=<billingId>
messageType.<id>.search.<searchModeId>.moduleId=<moduleId>

Где:

<billingId> - идентификатор биллинга;
<moduleId> - код экземпляра модуля DialUp.

Пример:

Блок кода

language	ruby
linenumbers	false

messageType.1.search.3.title=По логину DialUp
messageType.1.search.3.class=ru.bgcrm.plugin.bgbilling.dao.MessageTypeSearchContractByDialUpLogin
messageType.1.search.3.billingId=bg
messageType.1.search.3.moduleId=1

Режимы сохранения

Таблица. Режимы сохранения

Значение <saverClassName>

Что делает

Конфигурация и пример

ru.bgcrm.dao.message.MessageTypeContactSaverEmail

Сохранение EMail в параметр типа "email" контрагента. Возможно сохранение домена либо только EMail а.

Блок кода

language	ruby
linenumbers	false

messageType.<id>.saver.class=ru.bgcrm.dao.message.MessageTypeContactSaverEmail 
messageType.<id>.saver.paramId=<paramId>

Где:

<paramId> - код параметра понтрагента типа "EMail".

Пример:

Блок кода

language	ruby
linenumbers	false

messageType.1.saver.class=ru.bgcrm.dao.message.MessageTypeContactSaverEmail
messageType.1.saver.paramId=27

ru.bgcrm.dao.message.MessageTypeContactSaverPhone

Сохранение телефона в параметр типа "phone" контрагента. Возможно сохранение домена либо только EMail а.

Блок кода

language	ruby
linenumbers	false

messageType.<id>.saver.class=ru.bgcrm.dao.message.MessageTypeContactSaverPhone 
messageType.<id>.saver.paramId=<paramId>

Где:

<paramId> - код параметра понтрагента типа "Phone";
<format> - формат (param.phone.format) номера.

Пример:

Блок кода

language	ruby
linenumbers	false

messageType.1.saver.class=ru.bgcrm.dao.message.MessageTypeContactSaverPhone
messageType.1.saver.paramId=37
messageType.1.saver.format=13

ru.bgcrm.plugin.bgbilling.dao.MessageTypeContactSaverPhone

Сохранение телефона в параметр типа "телефон" договора биллинга.

Блок кода

language	ruby
linenumbers	false

messageType.<id>.saver.class=ru.bgcrm.plugin.bgbilling.dao.MessageTypeContactSaverPhone
messageType.<id>.saver.paramId=<paramId>
messageType.<id>.saver.format=<format>

Где:

<paramId> - код параметра типа "телефон" в биллинге;
<format> - формат (param.phone.format) номера.

Пример:

Блок кода

language	ruby
linenumbers	false

messageType.1.saver.class=ru.bgcrm.plugin.bgbilling.dao.MessageTypeContactSaverPhone
messageType.1.saver.paramId=27

Сообщения EMail

<messageTypeClassName>=ru.bgcrm.dao.message.MessageTypeEmail.

Дополнительные параметры:

Блок кода

language	java
linenumbers	false

messageType.<id>.email=<email>
messageType.<id>.host=<host>
messageType.<id>.login=<login>
messageType.<id>.pswd=<pswd>
messageType.<id>.folderIn=<inFolder>
messageType.<id>.folderProcessed=<processedFolder>
messageType.<id>.folderSkipped=<skippedFolder>
messageType.<id>.folderSent=<sentFolder>
#
# IMAP SSL протокол
#messageType.<id>.store=imaps
# порт, если не указано - 143 для IMAP, 993 для IMAP SSL
#messageType.<id>.port=
# отладка почтового обмена IMAP и SMTP
#messageType.<id>.debug=1
#
# параметры SMTP, добавляются после префикса идентично опциям из основной конфигурации
messageType.<id>....
# необязательные параметры
messageType.<id>.folderInProcessLinked=<inProcessedFolder>
messageType.<id>.signExpression=<signExpression>
# иной адрес отправителя письма
messageType.<id>.from=<from>
# адрес для ответов в письме
messageType.<id>.replayTo=<replayTo>

Входящие сообщения считываются с EMail ящика по протоколу IMAP. Сообщения считываются из папки <inFolder>. Параметры подключения IMAP задаются параметрами <host>, <login>, <pswd>. После разбора текста сообщений и вложений сообщение перемещается в <processedFolder>, при возникновении ошибок - в <skippedFolder>.

<email> подставляется в поле отправителя исходящего письма. Папка <inProcessedFolder> указывает папку, из которой считываются ответные письма на отправленные из BGCRM привязанные к процессу сообщения. Определение привязки производится по теме письма, в которую при отправке из BGCRM добавляется маркер с типом процесса.

Поля <from> и <replayTo> используются в случае необходимости в момент отправки подставить в поле "От" (From) иной адрес и "Ответить на" (Replay-To).

<signExpression> - JEXL выражение, определяющее подпись письма при отправке его через данный тип сообщения.

Отправка исходящих сообщий осуществляется через протокол SMTP, параметры настраиваются в конфигурации.

Пример настройки:

Блок кода

language	java
linenumbers	false

messageType.1.title=billing@bitel.ru
messageType.1.class=ru.bgcrm.dao.message.MessageTypeEmail
messageType.1.email=billing@bitel.ru
messageType.1.host=imap.ufamail.ru
messageType.1.login=billing@bitel.ru
messageType.1.pswd=*****
messageType.1.folderIn=INBOX
messageType.1.folderProcessed=INBOX.CRM_PROCESSED
messageType.1.folderSkipped=INBOX.CRM_SKIPPED
messageType.1.folderSent=INBOX.CRM_SENT
messageType.1.signExpression=NEW_LINE + user.getTitle() + NEW_LINE + "Служба технической поддержки" + NEW_LINE + "ОАО \"Инет\"" + NEW_LINE + "тел. 2232333" + NEW_LINE + "email. mastea@inet.ru" + NEW_LINE
messageType.1.mail.transport.protocol=smtp
messageType.1.mail.smtp.user=billing@bitel.ru
messageType.1.mail.smtp.host=smtp.ufamail.ru
messageType.1.mail.smtp.pswd=******

Сообщения Note

<messageTypeClassName>=ru.bgcrm.dao.message.MessageTypeNote.

Используются для добавления примечаний по ходу процесса.

Пример настройки:

Блок кода

language	ruby
linenumbers	false

#
messageType.100.title=Заметка
messageType.100.class=ru.bgcrm.dao.message.MessageTypeNote

Якорь

	message_type_call
	message_type_call

Сообщения Call

<messageTypeClassName>=ru.bgcrm.dao.message.MessageTypeCall.

Дополнительные необязательные параметры:

Блок кода

language	ruby
linenumbers	false

messageType.<id>.offerNumberFromParamId=<offerNumberFromParamId>

Где:

<offerNumberFromParamId> - код текстового параметра пользователя, содержащий номер, предлагаемый к занятию по-умолчанию.

Тип сообщения представляет из себя звонок, который обрабатывается оператором. Для данного типа сообщения в оснастке обработки сообщений отображается поле занятия номера. Строго говоря, это означает, что в системе может быть зарегистрирован только один тип сообщения Call.

По занятому номеру система определяет какой из пользователей получил звонок и открывает для него сообщение для обработки. Для включения данного функционала в переменной createOnStart конфигурации сервера должн быть указан класс ru.bgcrm.event.listener.MessageTypeCallListener. "Поставщиком" звонков может, например, выступить плагин Asterisk.

Дерево страниц

Сравнение версий

Старая версия 2

Новая версия 3

Ключ

Режимы поиска

Режимы сохранения

Сообщения EMail

Сообщения Note

Сообщения Call