Web-To-Object

PDF
Сложный

Web-to-Object — это механизм реализации простых односторонних интеграций с Creatio. С его помощью можно создавать записи в разделах Creatio (лиды, обращения, заказы и т. д.), просто отправив необходимые данные сервису Web-to-Object.

Наиболее распространенные случаи использования сервиса Web-to-Object:

  • Интеграция Creatio с пользовательскими лендингами и веб-формами. Вызов сервиса выполняется из лендинга (особым образом настроенная пользовательская страница со специальной web-формой), после отправки заполненной web-формы посетителем.
  • Интеграция с внешними системами, в результате работы которых должны создаваться объекты Creatio.

С помощью функциональности Web-to-Object можно настроить регистрацию в Creatio практически любых объектов. Например, в Creatio может быть зарегистрирован лид, контакт, заказ, обращение.

Для работы с лендингами в Creatio предусмотрен раздел Лендинги и web-формы. Этот раздел входит во все продукты Creatio, однако он может быть не включен по умолчанию в рабочие места некоторых продуктов (например, данный раздел не включен в рабочие места линейки продуктов Sales Creatio). Каждая запись раздела Лендинги и web-формы соответствует определенному лендингу. На странице записи предусмотрена вкладка Настройка лендинга.

Реализация сервиса Web-to-Object 

Основная функциональность механизма Web-To-Object содержится в пакете WebForm и является общей для всех продуктов. В зависимости от продукта Creatio эта функциональность расширена механизмами Web-to-Lead (пакет WebLeadForm), Web-to-Order (пакет WebOrderForm) и Web-to-Case (пакет WebCaseForm).

Для обработки данных, отправленных web-формой лендинга, в пакете WebForm реализован конфигурационный сервис GeneratedObjectWebFormService (класс Terrasoft.Configuration.GeneratedWebFormService). Данные веб-формы лендинга принимаются в качестве аргумента метода public string SaveWebFormObjectData(FormData formData). Затем они передаются в метод public void HandleForm(FormData formData) класса Terrasoft.Configuration.WebFormHandler, в котором и выполняется создание соответствующего объекта системы.

Внешний API сервиса Web-to-Object 

Для использования сервиса необходимо отправить POST-запрос по адресу
[Путь к приложению Creatio]/0/ServiceModel/GeneratedObjectWebFormService.svc/SaveWebFormObjectData
Например
http://myсreatio.com/0/ServiceModel/GeneratedObjectWebFormService.svc/SaveWebFormObjectData

Тип содержимого запроса — application/json. Кроме необходимых cookies, в содержимое запроса нужно добавить JSON-объект, содержащий данные веб-формы. Пример JSON-объекта:

{
    "formData":{
        "formId":"d66ebbf6-f588-4130-9f0b-0ba3414dafb8",
        "formFieldsData":[
            {"name":"Name","value":"John Smith"},
            {"name":"Email","value":"j.smith@creatio.com"},
            {"name":"Zip","value":"00000"},
            {"name":"MobilePhone","value":"0123456789"},
            {"name":"Company","value":"Creatio"},
            {"name":"Industry","value":""},
            {"name":"FullJobTitle","value":"Sales Manager"},
            {"name":"UseEmail","value":""},
            {"name":"City","value":"Boston"},
            {"name":"Country","value":"USA"},
            {"name":"Commentary","value":""},
            {"name":"BpmHref","value":"http://localhost/Landing/"},
            {"name":"BpmSessionId","value":"0ca32d6d-5d60-9444-ec34-5591514b27a3"}
        ]
    }
}

Интеграция с внешними системами 

Для интеграции с внешними системами необходимо:

1. Добавить запись в разделе Лендинги и web-формы.

2. Получить из конфигурационного объекта созданной записи адрес к сервису (свойство serviceUrl ) и идентификатор (свойство landingId).

3. Реализовать во внешней системе отправку POST-запроса к сервису Web-to-Object по полученному адресу. В запрос добавить необходимые данные в виде JSON-объекта. Свойству formId отправляемого JSON-объекта установить значение полученного идентификатора.

Смотрите также
Настроить web-форму для создания пользовательского объекта
Средний

Используя web-форму посадочной страницы (лендинга) стороннего сайта можно создать пользовательский объект в приложении Creatio. Подробнее о лендингах можно узнать из блока статей "Раздел Лендинги и web-формы".

Общий порядок действий при создании пользовательского объекта через web-форму:

  1. Зарегистрировать новый тип лендинга.
  2. Добавить страницу записи web-формы.
  3. Связать новый тип лендинга с созданной страницей записи.
  4. Актуализировать наполнение скриптами для страницы web-формы.
  5. Создать и настроить лендинг раздела [Лендинги и web-формы] ([Landing pages and web forms]).
  6. Развернуть и настроить посадочную страницу, содержащую web-форму.
  7. Зарегистрировать пользовательский объект в справочнике [Настройки объекта для элемента кампании "Лендинг" ([Entity settings for campaign landing element]).

Важно. Трекинг событий сайта работает только для лидов. Для пользовательских объектов трекинг событий сайта не работает.

Пример. Через web-форму посадочной страницы создайте пользовательский объект Контакт (Contact).

1. Зарегистрируйте новый тип лендинга 

Для регистрации нового типа лендинга выполните следующие действия:

  1. Перейдите в дизайнер системы по кнопке scr_Settings_button.png. В блоке [Настройка системы] ([System setup]) перейдите по ссылке [Справочники] ([Lookups]).
  2. Выберите справочник [Типы лендингов] ([Landing types]).
  3. Создайте новую запись.

Для создаваемой записи установите:

  • [Название] ([Name]) — "Contact";
  • [Объект] ([Object]) — "Contact".
scr_Lookup.png

2. Добавьте страницу web-формы 

В разделе Конфигурация (Configuration) пользовательского пакета на вкладке Схемы (Schemas) выполните действие Добавить —> Схема модели представления карточки (Add —> Schema of the Edit Page View Module). Процесс создания схемы модели представления карточки описан в статье "Cоздать клиентскую схему".

scr_SchemaEditPageViewModule.png

Для создаваемой схемы модели представления карточки установите:

  • [Заголовок] ([Title]) — "ContactGeneratedWebFormPage";
  • [Название] ([Name]) — "UsrContactGeneratedWebFormPage";
  • [Родительский объект] ([Parent object]) — "Edit page, landing".
scr_ContactGeneratedWebFormPage_Settings.png
UsrContactGeneratedWebFormPage.js
// UsrContactGeneratedWebFormPage — уникальное название схемы.
define("UsrContactGeneratedWebFormPage", ["UsrContactGeneratedWebFormPageResources"],
    function() {
        return {
            details: /**SCHEMA_DETAILS*/{}/**SCHEMA_DETAILS*/,
            methods: {
                /**
                 * @inheritdoc BaseGeneratedWebFormPageV2#getScriptTemplateFromResources
                 * @overriden
                 */
                getScriptTemplateFromResources: function() {
                    var scriptTemplate;
                    if (this.getIsFeatureEnabled("OutboundCampaign")) {
                        // ContactScriptTemplate — имя локализуемой строки.
                        scriptTemplate = this.get("Resources.Strings.ContactScriptTemplate");
                    } else {
                        scriptTemplate = this.get("Resources.Strings.ScriptTemplate");
                    }
                    return scriptTemplate;
                }
            },
            diff: /**SCHEMA_DIFF*/[]/**SCHEMA_DIFF*/
        };
    });

После внесения изменений сохраните схему.

Добавьте локализируемую строку ContactScriptTemplate. В значение строки добавьте <div>Test</div> . Больше информации о работе с локализуемыми строками содержится в статье "Работа с локализуемыми ресурсами".

scr_LocalizableString_Settings.png

После внесения изменений сохраните схему.

3. Свяжите новый тип лендинга с созданной страницей записи 

Чтобы связать новый тип лендинга с созданной страницей записи, добавьте запись в таблицу dbo.SysModuleEdit базы данных. Для этого выполните следующий SQL-запрос:

SQL script
MSSQL
PostgreSQL
-- Parameters of new landing page
DECLARE @editPageName nvarchar(250) = N'UsrContactGeneratedWebFormPage'; -- declare the name of the created schema
DECLARE @landingTypeName NVARCHAR(250) = N'Contact'; -- the type name of the landing
DECLARE @actionCaption NVARCHAR(250) = N'Contact form'; -- declare the type name for the landing in the section when creating a new record
 
-- Set system parameters based on new landing page
DECLARE @generatedWebFormEntityUId uniqueidentifier = '41AE7D8D-BEC3-41DF-A6F0-2AB0D08B3967';
DECLARE @cardSchemaUId uniqueidentifier = (select top 1 UId from SysSchema where Name = @editPageName);
DECLARE @pageCaption nvarchar(250) = (select top 1 Caption from SysSchema where Name = @editPageName);
DECLARE @sysModuleEntityId uniqueidentifier = (select top 1 Id from SysModuleEntity where SysEntitySchemaUId = @generatedWebFormEntityUId);
DECLARE @landingTypeId uniqueidentifier = (SELECT TOP 1 Id FROM LandingType WHERE Name = @landingTypeName);
 
-- Adding new Landing page variant to application interface
INSERT INTO SysModuleEdit
(Id, SysModuleEntityId, TypeColumnValue, UseModuleDetails, CardSchemaUId, ActionKindCaption, ActionKindName, PageCaption)
VALUES
(NEWID(), @sysModuleEntityId, @landingTypeId, 1, @cardSchemaUId, @actionCaption, @editPageName, @pageCaption)
DO $$
DECLARE
    v_editPageName VARCHAR(250) := N'ContactGeneratedWebFormPageV2';
    v_landingTypeName VARCHAR(250) := N'Contact';
    v_actionCaption VARCHAR(250) := N'Contact form';
    v_pageCaption varchar(250) := (select "Caption" from "SysSchema" where "Name" = v_editPageName);
    v_generatedWebFormEntityUId UUID := '41AE7D8D-BEC3-41DF-A6F0-2AB0D08B3967';
    v_cardSchemaUId UUID := (select "UId" from "SysSchema" where "Name" = v_editPageName);
    v_sysModuleEntityId UUID := (select "Id" from "SysModuleEntity" where "SysEntitySchemaUId" = v_generatedWebFormEntityUId);
    v_landingTypeId UUID := (SELECT "Id" FROM "LandingType" WHERE "Name" = v_landingTypeName);
BEGIN
    INSERT INTO "SysModuleEdit"
    ("SysModuleEntityId", "TypeColumnValue", "UseModuleDetails", "CardSchemaUId", "ActionKindCaption", "ActionKindName", "PageCaption")
    VALUES
    (v_sysModuleEntityId, v_landingTypeId, true, v_cardSchemaUId, v_actionCaption, v_editPageName, v_pageCaption);
END;
$$  LANGUAGE plpgsql;

Важно. 41AE7D8D-BEC3-41DF-A6F0-2AB0D08B3967 — неизменный идентификатор схемы сущности GeneratedWebForm в таблице dbo.SysSchema базы данных для любого кейса добавления посадочной страницы для пользовательской сущности.

После выполнения скрипта очистите кэш браузера. В результате в разделе Лендинги и web-формы (Landing pages and web forms) появится возможность добавить новый тип лендинга Contact form. Но при открытии страницы лендинга будет отсутствовать скрипт, который необходимо добавить в код посадочной страницы.

Реестр раздела Лендинги и web-формы (Landing pages and web forms)
scr_ContactForm.png
Страница лендинга
scr_LandingWithoutCode.png

4. Актуализируйте наполнение скриптами для страницы web-формы 

Значение переменной содержит экранированный html с тегами <script> и другую информацию по настройке связи полей web-формы — колонок создаваемой сущности. Это значение должно быть локализируемым. Для этого выполните следующий SQL-запрос:

-- Landing edit page schema name
DECLARE @editPageName nvarchar(250) = N'UsrContactGeneratedWebFormPage'; -- название созданной схемы
 
-- region Scripts' structure
DECLARE @sqriptPrefix nvarchar(max) = N'<div style="font-family: "Courier New", monospace; font-size: 10pt;"><script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script><br><script src="https://webtracking-v01.bpmonline.com/JS/track-cookies.js"></script><br><script src=##apiUrl##></script><br><script><br>/**<br>* Replace the "<span style="color: #0c0cec;">css-selector</span>" placeholders in the code below with the element selectors on your landing page.<br>* You can use #id or any other CSS selector that will define the input field explicitly.<br>* Example: "Email": "#MyEmailField".<br>* If you don"t have a field from the list below placed on your landing, leave the placeholder or remove the line.<br>*/<br>var config = {<br>    fields: {<br>        ';
DECLARE @sqriptDelimiter nvarchar(max) = N'<br>        ';
DECLARE @sqriptSuffix nvarchar(max) = N'<br>    },<br>    landingId: ##landingId##,<br>    serviceUrl: ##serviceUrl##,<br>    redirectUrl: ##redirectUrl##<br>};<br>/**<br>* The function below creates a object from the submitted data.<br>* Bind this function call to the "onSubmit" event of the form or any other elements events.<br>* Example: <form class="mainForm" name="landingForm" onSubmit="createObject(); return false"><br>*/<br>function createObject() {<br>    landing.createObjectFromLanding(config)<br>}<br>/**<br>* The function below inits landing page using URL parameters.<br>*/<br>function initLanding() {<br>    landing.initLanding(config)<br>}<br>jQuery(document).ready(initLanding)<br></script></div>';
-- endregion
 
-- region Scripts' variables
DECLARE @sqriptNameColumn nvarchar(max); -- объявляем переменные для колонок, которые будем мапить с лендингом
DECLARE @sqriptEmailColumn nvarchar(max);
DECLARE @scriptResult nvarchar(max);
-- endregion
 
-- Adding entity columns.
SET @sqriptNameColumn = N'"Name": "<span style="color: #0c0cec;">css-selector</span>", // Name of a contact';
SET @sqriptEmailColumn = N'"Email": "<span style="color: #0c0cec;">css-selector</span>", // Email';
 
-- Concat result scripts.
SET @scriptResult = @sqriptPrefix + @sqriptNameColumn + @sqriptDelimiter + @sqriptEmailColumn + @sqriptSuffix;
 
-- Set new localizable scripts value for resource with name like '%ScriptTemplate'
UPDATE SysLocalizableValue
SET [Value] = @scriptResult
WHERE SysSchemaId = (SELECT TOP 1 Id FROM SysSchema WHERE [Name] = @editPageName)
and [Key] like '%ScriptTemplate.Value'

В блоке Adding entity columns добавьте названия колонок сущности, которые будут заполняться значениями из web-формы.

Важно. Символы двойных кавычек (") и пробела ( ) необходимо заменить экранируемыми " и  .

Важно. Для добавления поля необходимо добавить переменную (@sqriptИмяПеременнойColumn) и конкатенировать ее в scriptResult.

Если после выполнения всех настроек появилась необходимость получать значения других полей (кроме Name и Email), то необходимо повторно выполнить скрипт из данного пункта, но в блоке Adding entity columns прописать все необходимые колонки, включая существующие. При повторном выполнении скрипта произойдет обновление ранее созданных настроек.

После выполнения скрипта необходимо открыть созданную в конфигурации схему и пересохранить ее, чтобы пересохранились ресурсы. В результате в разделе Лендинги и web-формы (Landing pages and web forms) при выборе Contact form будет отображена страница лендинга со скриптом, который необходимо разместить в коде посадочной страницы.

scr_Landing.png

Скрипт содержит конфигурационный объект config, в котором определены следующие свойства:

  • fields — содержит объект со свойствами Name и Email, значения которых должны совпадать с селекторами атрибутов id соответствующих полей web-формы.
  • landingId — содержит идентификатор лендинга в базе данных.
  • serviceUrl — содержит URL службы, по которому будут отправляться данные web-формы.
  • onSuccess — содержит функцию-обработчик успешного создания контакта. Необязательное свойство.
  • onError — содержит функцию-обработчик ошибки создания контакта. Необязательное свойство.

Конфиг, который будет формироваться, представлен ниже.

var config = {
    fields: {
        "Name": "css-selector", // Имя контакта
        "Email": "css-selector", // Email контакта
    },
    landingId: "b73790ab-acb1-4806-baea-4342a1f3b2a8",
    serviceUrl: "http://localhost:85/0/ServiceModel/GeneratedObjectWebFormService.svc/SaveWebFormObjectData",
    redirectUrl: ""
};

5. Создайте и настройте лендинг раздела [Лендинги и web-формы] ([Landing pages and web forms]) 

Чтобы создать новую запись лендинга необходимо в разделе Лендинги и web-формы (Landing pages and web forms) выбрать Contact form. Добавление записи в раздел Лендинги и web-формы (Landing pages and web forms) описано в статье "Как добавить новую запись в разделе Лендинги и web-формы".

Для создаваемой записи установите:

  • [Название] ([Name]) — "Contact";
  • [Домены сайта] ([Website domains]) — "http://localhost:85/Landing/LandingPage.aspx";
  • [Состояние] ([Status]) — "Active".
scr_Contact_Settings.png

Для применения изменений сохраните страницу.

6. Разверните и настройте посадочную страницу, содержащую web-форму 

Чтобы создать посадочную страницу для лендинга необходимо в любом текстовом редакторе при помощи html-разметки создать обычную посадочную страницу, содержащую web-форму. Создание посадочной страницы и добавление скрипта созданного лендинга в код посадочной страницы описаны в статье "Как связать лендинг на сайте с Creatio".

Для регистрации в Creatio данных контакта, отправляемых через web-форму, в код посадочной страницы необходимо добавить следующие поля (html-элемент <input>):

  • Имя контакта.
  • Email контакта.

Для каждого поля необходимо указать атрибуты name и id.

Чтобы при отправке данных web-формы в Creatio создавался новый объект Контакт (Contact), в посадочную страницу добавьте скрипт на языке JavaScript. Исходный код скрипта скопируйте из поля ШАГ 2. Скопируйте код и настройте в нем соответствие полей (STEP 2. Copy the code and configure and map the fields) страницы лендинга (рис. 8).

Конфигурационный объект config передается в качестве аргумента функции createObject(), которая должна выполняться при отправке web-формы.

Чтобы функция createObject() была вызвана при отправке web-формы, в тег <form> web-формы посадочной страницы добавьте атрибут onSubmit="createObject(); return false" из поля ШАГ 3. Вставьте настроенный код на страницу лендинга. Настройте запуск функции создания объекта по submit формы (STEP 3. Insert the customized code into the landing page source code. Set up a function to create the object on form submit) страницы лендинга.

Исходный код посадочной страницы
<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <!--ШАГ 2-->
    <!--Эту часть необходимо скопировать из поля ШАГ 2 страницы редактирования лендинга-->
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
    <script src="https://webtracking-v01.bpmonline.com/JS/track-cookies.js"></script>
    <script src="https://webtracking-v01.bpmonline.com/JS/create-object.js"></script>
    <script>
    
    /**
    * Замените выражение в кавычках "css-selector" в коде ниже значением селектора элемента на Вашей лендинговой странице.
    * Вы можете использовать #id или любой другой CSS селектор, который будет точно определять поле ввода на Вашей лендинговой странице.
    * Пример: "Email": "#MyEmailField".
    * Если Ваша лендинговая страница не содержит одного или нескольких полей из приведенных ниже – оставьте строку без изменений или удалите полностью.
    */
    var config = {
        fields: {
            "Name": "#name-field", // Имя контакта
            "Email": "#email-field", // Email контакта
        },
        landingId: "b73790ab-acb1-4806-baea-4342a1f3b2a8",
        serviceUrl: "http://localhost:85/0/ServiceModel/GeneratedObjectWebFormService.svc/SaveWebFormObjectData",
        redirectUrl: "",
        onSuccess: function(response) {
            window.alert(response.resultMessage);
        },
        onError: function(response) {
            window.alert(response.resultMessage);
        }
    };
    /**
    * Функция ниже создает объект из введенных данных.
    * Привяжите вызов этой функции к событию "onSubmit" формы или любому другому элементу события.
    * Пример: <form class="mainForm" name="landingForm" onSubmit="createObject(); return false">
    */
    function createObject() {
        landing.createObjectFromLanding(config)
    }
    /**
    * Функция ниже инициализирует лендинг из параметров URL.
    */
    function initLanding() {
        landing.initLanding(config)
    }
    jQuery(document).ready(initLanding)
    </script>
    <!--ШАГ 2-->
    
</head>
<body>
<h1>Landing web-page</h1>
<div>
    <h2>Contact form</h2>
    <form method="POST" class="mainForm" name="landingForm" onSubmit="createObject(); return false">
        Name:<br>
        <input type="text" name="Name" id="name-field"><br>
        Email:<br>
        <input type="text" name="Email" id="email-field"><br><br><br>
        <input type="submit" value="Submit">
        </font>
    </form>
</div>
</body>
</html>

Откройте посадочную страницу. Для создаваемого контакта установите:

  • [Name] — "New User";
  • [Email] — "new_user@creatio.com".
scr_LandingPage.png

Для создания контакта нажмите Submit.

Важно. Контакт с посадочной страницы будет добавлен в Creatio только в том случае, если страница размещена на сайте, имя которого указано в поле Домены сайта (Website domains) лендинга.

Если разместить страницу на локальном сервере компьютера, обслуживающего зарезервированное доменное имя localhost (как указано в настройке лендинга), то скрипт для создания контакта с посадочной страницы лендинга отработает корректно.

scr_SuccessfullyAdding.png

В результате в системе будет автоматически создан контакт с указанными параметрами.

scr_ContactCreating.png

7. Зарегистрируйте пользовательский объект в справочнике 

Для использования пользовательского лендинга в маркетинговых кампаниях (элемент [Добавить из лендинга] ([Landing page])), нужно зарегистрировать его в справочнике.

Регистрация объекта в справочнике [Настройки объекта для элемента кампании "Лендинг"] ([Entity settings for campaign landing element]):

  1. Перейдите в дизайнер системы по кнопке scr_Settings_button.png.
  2. В блоке [Настройка системы] перейдите по ссылке [Справочники] ([Lookups]).
  3. Откройте справочник [Настройки объекта для элемента кампании "Лендинг"] ([Entity settings for campaign landing element]).
  4. Нажмите [Добавить] ([Add]). Для создаваемого объекта заполните поля:
    • [Название] ([Caption]) — пользовательское название объекта.
    • [Объект] ([Entity object]) — создаваемый посадочной страницей объект системы.
    • [Путь к Контакту] ([Path to Contact]) — путь к колонке, которая связывает запись с контактом.
    • [Путь к идентификатору веб-формы] ([Path to WebForm]) — путь к колонке, которая связывает запись с посадочной страницей.
  5. Сохраните объект.

Пример заполнения полей для объектов [Лид] ([Lead]) и [Участник мероприятия] ([Event participant]) представлен в таблице.

Полей объектов [Лид] ([Lead]) и [Участник мероприятия] ([Event participant])
Имя поля Значение поля объекта
[Лид] ([Lead]) [Участник мероприятия] ([Event participant])
[Название] ([Caption]) Lead Event participant
[Объект] ([Entity object]) Lead Event participant
[Путь к Контакту] ([Path to Contact]) QualifiedContact Contact
[Путь к идентификатору веб-формы] ([Path to WebForm]) WebForm GeneratedWebForm

Для создаваемой записи установите:

  • [Название] (Caption) — "Contact";
  • [Объект] ([Entity object]) — "Lead";
  • [Путь к Контакту] ([Path to Contact]) — "QualifiedContact";
  • [Путь к идентификатору веб-формы] ([Path to WebForm]) — "WebForm".
scr_Contact_In_Lookup.png

Пользовательский лендинг "Contact" доступен к выбору в элементе [Добавить из лендинга] ([Landing page]) маркетинговых кампаний.

scr_Contact_In_Campaign.png
Реализовать обработчик для создания сущности с помощью web-формы
Сложный

В сущности Contact присутствует обязательная текстовая колонка CustomRequiredTextColumn. При создании участника мероприятия (EventTarget) при помощи web-формы в приложении выполняется поиск соответствующего контакта. Если контакт не найден, то по умолчанию создается новый контакт. При сохранении контакта возникает ошибка, поскольку не заполнено обязательное поле CustomRequiredTextColumn. Чтобы успешно сохранить контакт, необходимо реализовать пользовательский обработчик перед созданием участника мероприятия.

Пример. Реализовать пользовательский обработчик перед созданием участника мероприятия.

Перед выполнением примера настройте web-форму для создания пользовательского объекта. В web-форму добавьте обязательное пользовательское поле CustomRequiredTextColumn. Для этого воспользуйтесь инструкцией, которая приведена в статье Настроить web-форму для создания пользовательского объекта.

1. Реализовать пользовательский обработчик 

  1. Перейдите в раздел Конфигурация (Configuration) и выберите пользовательский пакет, в который будет добавлена схема.
  2. На панели инструментов реестра раздела нажмите Добавить —> Исходный код (Add —> Source code).

  3. В дизайнере схем заполните свойства схемы:

    • Код (Code) — "UsrCustomWebFormEventTargetPreProcessHandler".
    • Заголовок (Title) — "CustomWebFormEventTargetPreProcessHandler".

    Для применения заданных свойств нажмите Применить (Apply).

  4. Реализуйте пользовательский обработчик перед созданием участника мероприятия.

    1. В дизайнере схем добавьте пространство имен Terrasoft.Configuration.
    2. C помощью директивы using добавьте пространства имен, типы данных которых будут задействованы в классе.
    3. Добавьте название класса, которое соответствует названию схемы (свойство Код (Code)).
    4. В качестве родительского класса укажите класс WebFormEventTargetPreProcessHandler.

    Исходный код схемы UsrCustomWebFormEventTargetPreProcessHandler типа Исходный код (Source code) представлен ниже.

    UsrCustomWebFormEventTargetPreProcessHandler
    namespace Terrasoft.Configuration
    {
        using System;
        using System.Linq;
        using Core.Entities;
        using Core;
        using GeneratedWebFormService;
    
        #region Class: UsrCustomWebFormEventTargetPreProcessHandler
        /// <summary>
        /// Executes custom pre event target saving processing.
        /// </summary>
        /// <seealso cref="Terrasoft.Configuration.IGeneratedWebFormPreProcessHandler" />
        public class CustomWebFormEventTargetPreProcessHandler: WebFormEventTargetPreProcessHandler, IGeneratedWebFormPreProcessHandler
        {
    
            #region Properties: Private
            private UserConnection _userConnection { get; set; }
            private FormData _formData { get; set; }
            #endregion
    
            #region Methods: Private
            private string GetCustomRequiredColumnValue(string customColumnName) {
                var customFormField = this._formData.formFieldsData
                    .FirstOrDefault(x => x.name == customColumnName);
                if (customFormField == null) { 
                    throw new Exception($"There is no required form field {customColumnName}");
                }
                if (string.IsNullOrEmpty(customFormField?.value)) {
                    throw new Exception($"Required value is empty for field {customColumnName}");
                }
                return customFormField.value;
            }
            #endregion
            
            #region Methods: Protected
            /// <summary>
            /// Creates contact entity with custom required text column filled with form value.
            /// </summary>
            /// <param name="contactId">Unique identifier of contact.</param>
            /// <param name="contactNameField">Required contact name form field.</param>
            protected override void CreateContactEntity(Guid contactId, FormFieldsData contactNameField) {
                EntitySchema contactSchema = _userConnection.EntitySchemaManager.GetInstanceByName(nameof(Contact));
                Entity contact = contactSchema.CreateEntity(_userConnection);
                contact.SetDefColumnValues();
                contact.SetColumnValue("Id", contactId);
                contact.SetColumnValue("Name", contactNameField.value);
    
                // set value for custom required column.
                var customRequiredColumnName = nameof(Contact.CustomRequiredTextColumn);
                var customRequiredColumnValue = GetCustomRequiredColumnValue(customRequiredColumnName);
                contact.SetColumnValue(customRequiredColumnName, customRequiredColumnValue);
    
                contact.Save(false);
            }
            #endregion
    
            #region Methods: Public
            /// <inheritdoc/>
            /// Override for base method implementation to init <see cref="UserConnection"/> instance and <see cref="FormData"/>.
            public new FormData Execute(UserConnection userConnection, FormData formData,
                    IWebFormImportParamsGenerator paramsGenerator) {
                _userConnection = userConnection;
                _formData = formData;
                return base.Execute(userConnection, formData, paramsGenerator);
            }
            #endregion
        }
        #endregion
    }
    
  5. На панели инструментов дизайнера нажмите Сохранить (Save), а затем Опубликовать (Publish).

2. Зарегистрировать пользовательский обработчик в базе данных 

Реализация пользовательского обработчика предполагает его обязательную регистрацию в таблице [WebFormProcessHandlers] базы данных.

Способы регистрации пользовательского обработчика в базе данных:

  • С помощью справочника.

    Чтобы зарегистрировать пользовательский обработчик в базе данных с помощью справочника:

    1. Перейдите в дизайнер системы по кнопке .
    2. В блоке Настройка системы (System setup) перейдите по ссылке Справочники (Lookups).
    3. Добавьте новую запись для обработчика в справочник для сущности Обработчики веб-форм (Web form process handlers). По умолчанию этот справочник не добавлен в перечень справочников приложения. Чтобы добавить справочник Обработчики веб-форм (Web form process handlers) в приложение, создайте справочник и в качестве объекта выберите объект Обработчики веб-форм (Web form process handlers).
    4. Заполните поля справочника:

      • Имя объекта — "EventTarget".
      • FullClassName — "Terrasoft.Configuration.CustomWebFormEventTargetPreProcessHandler, Terrasoft.Configuration".
      • Установите признак Активный (isActive).
  • С помощью SQL-запроса.

    Чтобы зарегистрировать пользовательский обработчик в базе данных с помощью SQL-запроса, выполните следующий SQL-запрос.

    SQL-запрос
    INSERT INTO WebFormProcessHandlers (Id, EntityName, FullClassName, IsActive)
        VALUES (NEWID(), N'EventTarget', 'Terrasoft.Configuration.CustomWebFormEventTargetPreProcessHandler, Terrasoft.Configuration', 1)
    

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

Способы отключения коробочного обработчика:

  • С помощью справочника.

    Чтобы отключить коробочный обработчик с помощью справочника:

    1. Перейдите в дизайнер системы по кнопке .
    2. В блоке Настройка системы (System setup) перейдите по ссылке Справочники (Lookups).
    3. Откройте справочник и для сущности Участник мероприятия (EventTarget), у которого в поле FullClassName установлено значение "Terrasoft.Configuration.CustomWebFormEventTargetPreProcessHandler, Terrasoft.Configuration", отключите признак Активный (isActive).
  • С помощью SQL-запроса.

    Чтобы отключить коробочный обработчик с помощью SQL-запроса, выполните следующий SQL-запрос.

    SQL-запрос
    UPDATE WebFormProcessHandlers
    SET IsActive = 0
    WHERE FullClassName = 'Terrasoft.Configuration.WebFormEventTargetPreProcessHandler, Terrasoft.Configuration'
    

Результат выполнения примера 

Чтобы посмотреть результат выполнения примера, перезапустите пул приложения.

В результате новый контакт создается при отправке формы с заполненными обязательными полями, среди которых присутствует поле CustomRequiredTextColumn.