Инструкция по настройке Transaction Server

Оглавление

Общее описание

Коннектор Transaction Server предназначен для интеграции бизнес-систем. В данной инструкции описаны возможности и подходы для реализации интеграции Microsoft Dynamics CRM 2011 и 1C 8.2.

Коннектор работает на основе событий. Т.е. при возникновении определенного события в одной из систем срабатывает логика, которая производит необходимые изменения в другой системе. Логика описывается при помощи .Net Workflow Foundation.

Используемые термины

Подключение – Конкретный установленный экземпляры 1С, либо Microsoft CRM.

Для 1С подключение характеризируется путем к файлу баз данных для файловой версии, либо именем сервера 1С и базы для серверной. Также содержит пользователя, от которого будет работать коннектор

Для CRM подключение характеризуется именем сервера, названием организации, признаком использования IFD и другими настройками

Метаданные – список сущностей 1С или CRM с атрибутами. Для каждого подключения может быть свой набор метаданных.

Маппинг – список соответствия атрибутов одной сущности одной системы атрибутам другой сущности другой системы. Содержит пару сущностей для который задается маппинг и перечень соответствующих атрубитов, например:

Контрагент (1С)	Account(CRM)
Наименование	Name
ПолноеНаименование	New_fullname
БИК	New_bik

Для описания маппингов импользуються имена схем в Microsoft CRM и названия реквизитов 1С.

Событие – событие изменения данных, произошедшее в одном из подключений. Характеризуется названием подключения в котором возникло, типом события (Create, Update, Delete). Также содержит поля измененного объекта

Бизнес-процесс – процесс, в котором указана логика обработки события. Может включать в себя создание, изменение, удаление записей в другой системе. Также может содержать другие действия

Настройка подключений

Для настройки подключений необходимо воспользоваться утилитой настройки, которая поставляется вместе с коннектором. Она установлена в папке коннектора и называется Integration.exe.

Для настройки подключений перейдите в вкладку Подключения -> Подключения

Создание нового подключения

1. 
   Нажмите кнопку Создать
   
2. 
   В появившемся окне введите название подключения и выберите соответствующую систему:
   
3. 
   После добавления подключения перейдите в вкладку Настройки и выберите систему, для которой вы создали подключение. После этого выберите подключение:
   
4. 
   Заполните параметры подключения. Параметры сохраняются автоматически
   

Описание параметров подключения к системам

Для системы 1С используются следующие параметры:

• 
  Cluster – Название кластера сервера 1С (в случае использования серверной версии)
  
• 
  Database – Название базы на сервере 1С (в случае использования серверной версии)
  
• 
  Path – путь к файлу базы данных (в случае файловой версии)
  
• 
  User – Логин пользователя
  
• 
  Password – Пароль
  
• 
  Messagestore – необходимо установить в true в случае если подключение является источником событий. Т.е. из этого подключения происходит интеграция в другие подключения.
  

Для системы CRM используются следующие параметры:

• 
  url – Адрес сервера, например crmonline.contoso.com
  
• 
  organization – Название организации
  
• 
  ssl – Признак использования ssl (true, или false)
  
• 
  ifd – Признак включенного IFD режима (true, или false)
  
• 
  domain – Домен пользователя
  
• 
  user – Пользователь
  
• 
  password – Пароль
  
• 
  messagestore – необходимо установить в true в случае если подключение является источником событий. Т.е. из этого подключения происходит интеграция в другие подключения.
  

Настройка интеграции

Обновление метаданных

После настройки нового подключения, либо в случае когда в одной из систем поменялись атрибуты объектов, либо другие используемые метаданные, необходимо перейти в закладку Обновить метаданные и нажать Обновить.

После этого начнется процесс выгрузки названий сущностей, справочников, документов и их реквизитов из подключений 1С и Microsoft CRM. Это может занять несколько минут

Создание маппингов

Маппинг – список соответствия атрибутов одной сущности одной системы атрибутам другой сущности другой системы. Содержит пару сущностей для который задается маппинг и перечень соответствующих атрубитов

Для создания маппинга:

1. 
   Зайдите в раздел Таблицы -> Маппинги
   
2. 
   Выберите исходное и конечное подключение, как на рисунке
   
3. 
   Нажмите Добавить, или щелкните два раза на существующем маппинге, чтобы его изменить
   
4. 
   В появившемся окне введите названия маппинга (оно понадобиться при настройке бизнес-процессов), а также исходный и целевой объект.
   

5. 
   В появившемся окне отобразиться список атрибутов маппинга (при создании нового маппинга, этот список будет пустой). Для добавление атрибутов маппинга нажмите Добавить
   
6. 
   В появившемся окне выберите исходный и конечный атрибут. Галочка замена, значит что поле – это ссылка на другой справочник,документ или сущность и необходимо заменить ключ объекта в одной системе ключом объекта в другой системе
   

Создание бизнес-процессов

Бизнес-процесс – процесс, в котором указана логика обработки события. Может включать в себя создание, изменение, удаление записей в другой системе. Также может содержать другие действия

Управление бизнес-процессами происходит во вкладке Бизнес-процессы -> Все бизнес-процессы

1. 
   Нажмите добавить для Добавления нового бизнес-процесса или щелкните два раза на существующем для редактирования
   
2. 
   После этого откроется форма редактирования логики бизнес процесса.
   

3. 
   Задайте последовательность обработки сообщения перетаскивая элементы логики слева от редактора перетаскиванием их на область редактирования (Для задания логики бизнес-процессов используется механизм Windows Workflow Foundation, с ним можно ознакомиться по адресу http://msdn.microsoft.com/en-us/netframework/dd980559#content4 ).
   
4. 
   Нажмите кнопку Сохранить для сохранения бизнес-процесса в базе, при необходимости введите название процесса
   

Подписка бизнес-процесса на события

Подписки на события позволяют запускать определенный бизнес-процесс в зависимости от произошедшего в одной из систем события, например создания Контрагента в 1С.

1. 
   Перейдите во вкладку Бизнес-процессы -> Все бизнес-процессы и выберите процесс, который вы хотите подписать на событие
   

2. 
   В области справа нажмите Назначить. В появившемся окне введите Подключение, Сущность и Событие на которое должен реагировать бизнес процесс.
   

3. 
   Нажмите Ок.
   

Пример бизнес-процесса

Рассмотрим часто используемый шаблон бизнес-процесса на примере интеграции банков из 1С в Microsoft CRM. В Microsoft CRM это сущность, созданная в процессе настройки, в 1С – стандартная.

1. 
   Для начала создадим маппинг с необходимым списком атрибутов для интеграции:
   

2. 
   После этого перейдем в бизнес-процессы и создадим новый процесс.
   
3. 
   После этого перетащите на область редактирования элементы бизнес-логики в следующей последовательности:
   
   1. 
      Sequence – этот элемент, который содержит в себе последовательность других элементов
      
   2. 
      GetDestEntity – этот элемент проверит есть ли в Microsoft CRM уже этот банк, или его необходимо создать
      
   3. 
      MapEntity – перенесет необходимые атрибуты из исходного Банка в Банк в CRM, пока не создавая сам объект в CRM
      
   4. 
      If (String.IsNullOrEmpty(Target.Id)) – проверяет есть ли идентификатор у объекта в CRM (Этот идентификатор был бы заполнен GetDestEntity, в случае если Банк есть в CRM)
      
   5. 
      В зависимости от того есть или нет он в CRM:
      
      1. 
         Если есть – вызываем CRMUpdate для обновления в CRM
         
      2. 
         Если нет – вызываем CRMCreate для создания в CRM и MapId для сохранения в базе коннектора соответствия между идентификаторами 1С и CRM для дальнейшего использования (Это соответствие в дальнейшем используется GetDestEntity)
         

Перечень активностей

Активности Microsoft CRM

CRMCreate

Активность создает запись в системе Microsoft CRM. По результату выполнения записывает в поле Id переданного объекта Entity идентификатор созданной записи в системе CRM.

Параметры:

• 
  Context – переменная контекста
  
• 
  Entity – объект, который необходимо создать
  

CRMDelete

Активность удаляет запись в системе Microsoft CRM.

Параметры:

• 
  Context – переменная контекста
  
• 
  Entity – объект, который необходимо удалить
  

CRMGetEntities

Активность возвращает коллекцию объектов, с заданным набором полей по заданному фильтру.

Параметры:

• 
  Context – переменная контекста
  
• 
  Connection – название соединения Microsoft CRM
  
• 
  Entity – текстовое название имени схемы возвращаемых объектов, например “account” или “contact”
  
• 
  Filter – фильтр, а также набор возвращаемых полей. Задается при помощи визуального редактора
  
• 
  Entities – выходной аргумент, типа List, коллекция объектов, удовлетворяющая фильтру
  

CRMGetEntity

Возвращает идентификатор объекта по значению одного из полей

Параметры:

• 
  Context – переменная контекста
  
• 
  Connection – название соединения Microsoft CRM
  
• 
  Dictionary – текстовое название имени схемы возвращаемого объекта, например “account” или “contact”
  
• 
  Field – имя схемы поля, по которому производится поиск (например “name”)
  
• 
  Value – значение поля, по которому производится поиск
  
• 
  ResultId – возвращаемое значение типа строка – идентификатор найденной записи
  

CRMGetEntityById

Возвращает объект CRM по его идентификатору в системе

Параметры:

• 
  Context – переменная контекста
  
• 
  Attributes – массив атрибутов объекта, которые необходимо вернуть
  
• 
  EntityName – текстовое название имени схемы возвращаемого объекта, например “account” или “contact”
  
• 
  EntityId – идентификатор объекта
  
• 
  SystemName – название соединения Microsoft CRM
  
• 
  Target – возвращаемое значение типа Entity
  

CRMGetPicklistValue

Возвращает значение пиклиста по текстовому представлению значения. Например, для пиклиста перечня форм собственности (1 – ФОП, 2 – ООО, 3 – ЗАО, 4 - ОАО), по текстовому значению формы собственности, например ООО, возвращает соответствующее ему число, для ООО – 2. При соответствующих параметрах может также добавлять значения в пиклист

Для работы активности необходимо заполнить либо поля EntityName, AttributeName, либо поле OptionSet, в зависимости от того, глобальный это пиклист или нет

Параметры:

• 
  Context – переменная контекста
  
• 
  EntityName – текстовое название имени схемы объекта, содержащего атрибут, например “account” или “contact”
  
• 
  AttributeName– имя схемы атрибута типа пиклист
  
• 
  OptionSet – имя схемы глобального пиклиста (заполняется в случае, если пиклист глобальный)
  
• 
  Connection– название соединения Microsoft CRM
  
• 
  ValueName – искомое текстовое представление значения пиклиста (поиск выполняется на языке пользователя, от которого работает коннектор)
  
• 
  CreateNew – признак необходимости создания нового значения в случае, если оно не будет найдено. Если значение этого параметра false и значение пиклиста не найдено – будет возвращено значение -1
  
• 
  IntValue – возвращаемое значения типа string, содержащее номер искомого значения (“-1” если значение не найдено)
  

CRMUpdate

Обновляет объект в системе CRM

Параметры:

• 
  Context – переменная контекста
  
• 
  Entity – объект, который необходимо обновить
  

Активности 1С

OSCreate

Активность создает запись в системе 1C. По результату выполнения записывает в поле Id переданного объекта Entity идентификатор созданной записи в системе 1C.

Параметры:

• 
  Context – переменная контекста
  
• 
  Entity – объект, который необходимо создать
  

OSDelete

Активность ставит пометку на удаление записи в системе 1C. В случае строки документа – удаляет строку.

Параметры:

• 
  Context – переменная контекста
  
• 
  Entity – объект, который необходимо удалить
  

OSUpdate

Обновляет объект в системе 1C.

Параметры:

• 
  Context – переменная контекста
  
• 
  Entity – объект, который необходимо обновить
  

OSGetContactInfo

Активность получает запись регистра контактной информации 1С

Параметры:

• 
  Context – переменная контекста
  
• 
  Connection – название соединения 1С
  
• 
  Attributes – массив атрибутов, которые надо вернуть
  
• 
  Type – тип контактной информации (Например “Телефон”)
  
• 
  KindCode – код вида контактной информации (Например “00022”)
  
• 
  ObjectId – идентификатор объекта, который является владельцем контактной информации, например идентификатор контрагента, или контактного лица
  
• 
  Target – возвращаемое значение типа Entity, содержащее искомую запись регистра. В случае сли запись не найдена – возвращает Nothing
  

OSGetDictionaryValue

Возвращает идентификатор объекта по значению одного из полей

Параметры:

• 
  Context – переменная контекста
  
• 
  Connection – название соединения 1С
  
• 
  Dictionary – текстовое название имени схемы возвращаемого объекта, например “Контрагенты” или “КонтактныеЛица”. Обратите внимание, что использовать полное имя “Справочники.Контрагенты” не нужно. Используйте вместо этого только название справочника
  
• 
  Field – имя схемы поля, по которому производится поиск (например “Код”)
  
• 
  Value – значение поля, по которому производится поиск
  
• 
  ResultId – возвращаемое значение типа строка – идентификатор найденной записи
  

OSGetEntities

Активность возвращает коллекцию объектов, с заданным набором полей по заданному фильтру.

Параметры:

• 
  Context – переменная контекста
  
• 
  Connection – название соединения 1С
  
• 
  Entity – текстовое название имени схемы возвращаемых объектов, например “Справочники.Контрагенты” или “Документы.ЗаказыПокупателей”
  
• 
  Filter – фильтр, а также набор возвращаемых полей. Задается при помощи визуального редактора
  
• 
  Entities – выходной аргумент, типа List, коллекция объектов, удовлетворяющая фильтру
  

OSGetEntityById

Возвращает объект 1C по его идентификатору в системе

Параметры:

• 
  Context – переменная контекста
  
• 
  Fields – массив атрибутов объекта, которые необходимо вернуть
  
• 
  Entity – текстовое название имени схемы возвращаемого объекта, например “Справочники.Контрагенты” или “Документы.ЗаказыПокупателей”
  
• 
  Id – идентификатор объекта
  
• 
  Connection– название соединения 1С
  
• 
  Result – возвращаемое значение типа Entity
  

OSGetEntityField

Возвращает значение поля объекта 1С

Параметры:

• 
  Context – переменная контекста
  
• 
  Field – атрибут объекта, который необходимо вернуть
  
• 
  Id – идентификатор объекта
  
• 
  Connection – название соединения 1С
  
• 
  Result – возвращаемое значение поля
  

OSGetListName

Возвращает текстовое представление перечисления по идентификатору

Параметры:

• 
  Context – переменная контекста
  
• 
  Id – идентификатор перечисления
  
• 
  Connection – название соединения 1С
  
• 
  Name – возвращаемое текстовое представление значение перечисления
  

OSGetListValue

Обратная процедура по отношению к OSGetListName, за исключением того, что возвращается не идентификатор, а ссылка в формате 1С (ком-объект), ее можно записать в поле, которое ссылается на это перечисление при интеграции объекта в 1С. Возвращает ссылку на значение перечисления по текстовому представлению значения

Параметры:

• 
  Context – переменная контекста
  
• 
  List – имя схемы перечисления, например “СхемыНалогообложения” , обратите внимание что используется сокращенный формат записи, а не полный “Перечисления. СхемыНалогообложения ”
  
• 
  Connection – название соединения 1С
  
• 
  Value – искомое текстовое представление значение перечисления (В нашем случае, например “Плательщик НДС”)
  
• 
  ResultId – возвращаемое значение ссылки на значение перечисления.
  

OSMoveDocument

Проводит документ в системе 1С

Параметры:

• 
  Context – переменная контекста
  
• 
  Entity – документ, который необходимо провести
  

OSUnMoveDocument

Отменяет проведение документа в системе 1С

Параметры:

• 
  Context – переменная контекста
  
• 
  Entity – документ, проведение которого необходимо отменить