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

1. Создать процесс добавления контакта 

1. Перейдите в раздел Конфигурация (Configuration) и выберите пользовательский пакет, в который будет добавлен бизнес-процесс.
2. Перейдите в дизайнер процессов.

3. Заполните свойства бизнес-процесса:

   • Название (Name) — "Add New External Contact".
   • Код (Code) — "UsrAddNewExternalContact".

   Для остальных свойств используйте значения по умолчанию.

   

4. Добавьте параметры бизнес-процесса.

   С помощью параметров в процесс передаются данные добавляемого контакта — имя и телефон.

   Значения параметров бизнес-процесса, которые необходимо заполнить, представлены в таблице ниже.

   Значения параметров бизнес-процесса

   Заголовок (Title)	Код (Code)	Тип данных (Data type)
   Параметр ContactName
   "Имя контакта" ("Contact Name")	"ContactName"	"Текст (50 символов)" ("Text (50 characters)")
   Параметр ContactPhone
   "Телефон контакта" ("Contact Phone")	"ContactPhone"	"Текст (50 символов)" ("Text (50 characters)")

   

5. Добавьте элемент Задание-сценарий (ScriptTask).

   1. Заполните значения свойств элемента:

      • Название (Name) — "Add contact".
      • Код (Code) — "ScriptTaskAddContact".

   2. Реализуйте логику добавления нового контакта.

      Чтобы редактировать код сценария, дважды щелкните по элементу на диаграмме. На панели настройки элемента откроется окно для ввода и редактирования программного кода.

      ScriptTaskAddContact

      /* Создает экземпляр схемы объекта [Contact]. */
      var schema = UserConnection.EntitySchemaManager.GetInstanceByName("Contact");
      /* Создает экземпляр нового объекта. */
      var entity = schema.CreateEntity(UserConnection);
      /* Устанавливает значения по умолчанию для колонок объекта. */
      entity.SetDefColumnValues();
      string contactName = Get<string>("ContactName");
      string contactPhone = Get<string>("ContactPhone");
      /* Устанавливает значения колонки [Name] из параметра процесса. */
      entity.SetColumnValue("Name", contactName);
      /* Устанавливает значения колонки [Phone] из параметра процесса. */
      entity.SetColumnValue("Phone", contactPhone);
      /* Сохраняет новый контакт. */
      entity.Save();
      return true;
      

6. Нажмите на кнопку Сохранить (Save) на панели инструментов дизайнера процессов.

2. Создать процесс чтения всех контактов 

Бизнес-процесс, который формирует перечень всех контактов, также содержит один элемент Задание-сценарий (ScriptTask).

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

1. Перейдите в раздел Конфигурация (Configuration) и выберите пользовательский пакет, в который будет добавлен бизнес-процесс.
2. Перейдите в дизайнер процессов.

3. Заполните свойства бизнес-процесса:

   • Название (Name) — "Get All Contacts".
   • Код (Code) — "UsrGetAllContacts".

   Для остальных свойств используйте значения по умолчанию.

   

4. Добавьте параметр бизнес-процесса.

   Заполните значения параметра бизнес-процесса:

   • Заголовок (Title) — "Contact List".
   • Код (Code) — "ContactList".
   • Тип данных (Data type) — "Строка неограниченной длины" ("Unlimited length text").
   

   Параметр возвращает перечень всех контактов приложения в виде JSON-объекта.

5. Добавьте элемент Задание-сценарий (ScriptTask).

   1. Заполните значения свойств элемента:

      • Название (Name) — "Get all contacts".
      • Код (Code) — "ScriptTaskGetAllContacts".

   2. Реализуйте логику чтения контактов.

      Чтобы редактировать код сценария, дважды щелкните по элементу на диаграмме. На панели настройки элемента откроется окно для ввода и редактирования программного кода.

      ScriptTaskGetAllContacts

      /* Создание экземпляра EntitySchemaQuery. */
      EntitySchemaQuery query = new EntitySchemaQuery(UserConnection.EntitySchemaManager, "Contact");
      /* Признак для обязательного выбора первичной колонки [Id]. */
      query.PrimaryQueryColumn.IsAlwaysSelect = true;
      /* Добавление в запрос колонок. */
      query.AddColumn("Name");
      query.AddColumn("Phone");
      /* Получение результирующей коллекции. */
      var entities = query.GetEntityCollection(UserConnection);
      /* Формирование списка контактов для сериализации в JSON. */
      List<object> contacts = new List<object>();
      foreach (var item in entities)
      {
          var contact = new
          {
              Id = item.GetTypedColumnValue<Guid>("Id"),
              Name = item.GetTypedColumnValue<string>("Name"),
              Phone = item.GetTypedColumnValue<string>("Phone")
          };
          contacts.Add(contact);
      }
      /* Сохранение сериализованной в JSON коллекции контактов в параметр ContactList. */
      string contactList = JsonConvert.SerializeObject(contacts);
      Set<string>("ContactList", contactList);
      return true;
      

6. Нажмите на кнопку Сохранить (Save) на панели инструментов дизайнера процессов.

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

1. Запустить выполнение бизнес-процессов из строки браузера.

   1. Запустите процесс создания нового контакта. Для этого в строку навигации браузера введите URL, который приведен ниже.

      URL для запуска процесса создания нового контакта

      http[s]://[Адрес приложения Creatio]/0/ServiceModel/ProcessEngineService.svc/UsrAddNewExternalContact/Execute?ContactName=John Johanson&ContactPhone=1 111 111 1111
      

      В результате в приложении будет добавлен новый контакт.

      

      Важно. Новый контакт создается при каждом успешном запросе к сервису. Если выполнить несколько запросов с одинаковыми параметрами, создается несколько контактов-дублей.

   2. Запустите процесс чтения всех контактов. Для этого в строку навигации браузера введите URL, который приведен ниже.

      URL для запуска процесса чтения всех контактов

      http[s]://[Адрес приложения Creatio]/0/ServiceModel/ProcessEngineService.svc/UsrGetAllContacts/Execute?ResultParameterName=ContactList
      

      В результате в окне браузера отображается JSON-объект, который содержит коллекцию контактов.

      

2. Запустить выполнение бизнес-процессов из консольного приложения.

   Исходный код консольного пользовательского приложения, который предназначен для запуска бизнес-процессов с помощью сервиса ProcessEngineService.svc, доступен на GitHub.

   1. Выполните аутентификацию. Для этого используйте сервис аутентификации AuthService.svc. Используйте пример, который доступен в статье Реализовать аутентификацию на C#.

   2. В исходный код класса Program добавьте строковое поле, которое содержит базовый URL сервиса.

      URL для формирования запросов к сервису ProcessEngineService.svc

      private const string processServiceUri = baseUri + @"/0/ServiceModel/ProcessEngineService.svc/";
      

   3. В исходный код класса Program добавьте метод GET для выполнения запуска бизнес-процесса создания нового контакта.

      Метод GET для выполнения запуска бизнес-процесса

      public static void AddContact(string contactName, string contactPhone)
      {
          /* Формирует URL запрос. */
          string requestString = string.Format(processServiceUri +
                  "UsrAddNewExternalContact/Execute?ContactName={0}&ContactPhone={1}",
                                   contactName, contactPhone);
          /* Создает Http-запрос. */
          HttpWebRequest request = HttpWebRequest.Create(requestString) as HttpWebRequest;
          request.Method = "GET";
          request.CookieContainer = AuthCookie;
          /* Выполняет запрос и анализ Http-ответа. */
          using (var response = request.GetResponse())
          {
              /* Выводит свойства http-ответа, поскольку сервис вернет пустую строку. */
              Console.WriteLine(response.ContentLength);
              Console.WriteLine(response.Headers.Count);
          }
      }
      

   4. В исходный код класса Program добавьте метод GET для выполнения запуска бизнес-процесса чтения вскх контактов Creatio.

      Метод GET для выполнения запуска бизнес-процесса

      public static void GetAllContacts()
      {
          /* Формирует URL запроса. */
          string requestString = processServiceUri +
                             "UsrGetAllContacts/Execute?ResultParameterName=ContactList";
          HttpWebRequest request = HttpWebRequest.Create(requestString) as HttpWebRequest;
          request.Method = "GET";
          request.CookieContainer = AuthCookie;
          /* Создает Http-запрос. */
          using (var response = request.GetResponse())
          {
              /* Выполняет запрос и выводит результат. */
              using (var reader = new StreamReader(response.GetResponseStream()))
              {
                  string responseText = reader.ReadToEnd();
                  Console.WriteLine(responseText);
              }
          }
      }
      

   5. Реализуйте вызов добавленныех методов в основном методе приложения после успешной аутентификации.

      Реализация вызова методов

      static void Main(string[] args)
      {
          if (!TryLogin("Supervisor", "Supervisor"))
          {
              Console.WriteLine("Wrong login or password. Application will be terminated.");
          }
          else
          {
              try
              {
                  /* Вызывает методы запуска бизнес-процессов. */
                  AddContact("John Johanson", "+1 111 111 1111");
                  GetAllContacts();
              }
              catch (Exception)
              {
                  /* Обрабатывает исключения. */
                  throw;
              }
          };
          Console.WriteLine("Press ENTER to exit...");
          Console.ReadLine();
      }
      

   

1. Реализовать пользовательский бизнес-процесс Проведение встречи 

1. Создайте бизнес-процесс Проведение встречи (Conducting a meeting). Для этого реализуйте пример, который приведен в статье Отправить email-сообщение при помощи процесса документации по настройке процессов.

2. Добавьте параметр бизнес-процесса.

   Заполните значения параметра бизнес-процесса.

   • Заголовок (Title) — "Meeting contact".
   • Код (Code) — "ProcessSchemaContactParameter".
   • Тип данных (Data type) — "Уникальный идентификатор" ("Unique identifier").
   

3. В свойство Контакт (Contact) действия процесса Позвонить клиенту (Call customer) добавьте входящий параметр "[#Meeting contact#]".

   

2. Реализовать пользовательское действие страницы контрагента 

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

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

   1. В контекстном меню узла Локализуемые строки (Localizable strings) нажмите кнопку .

   2. Заполните свойства локализуемой строки.

      • Код (Code) — "CallProcessCaption".
      • Значение (Value) — "Назначить встречу" ("Schedule a meeting").
   3. Для добавления локализуемой строки нажмите Добавить (Add).

3. Реализуйте логику работы пункта меню.

   1. В качестве зависимости подключите модуль ProcessModuleUtilities.

   2. В свойстве methods реализуйте методы:

      • callCustomProcess() — метод-обработчик действия. Реализует метод executeProcess() модуля ProcessModuleUtilities, в который в качестве параметра передаются имя созданного бизнес-процесса и объект с проинициализированными входящими параметрами для процесса.
      • isAccountPrimaryContactSet() — проверяет наличие у контрагента основного контакта.
      • getActions() — переопределенный базовый метод. Возвращает коллекцию действий замещающей страницы.

   Исходный код схемы замещающей модели представления страницы контрагента представлен ниже.

   AccountPageV2

   define("AccountPageV2", ["ProcessModuleUtilities"], function(ProcessModuleUtilities) {
       return {
           /* Название схемы объекта страницы записи. */
           entitySchemaName: "Account",
           /* Методы модели представления страницы записи. */
           methods: {
               /* Проверяет заполнение поля [Основной контакт] страницы контрагента. */
               isAccountPrimaryContactSet: function() {
                   return this.get("PrimaryContact") ? true : false;
               },
               /* Переопределяет базовый виртуальный метод, который возвращает коллекцию действий страницы записи. */
               getActions: function() {
                   /* Вызывает родительскую реализацию метода для получения коллекции проинициализированных действий базовой страницы. */
                   var actionMenuItems = this.callParent(arguments);
                   /* Добавляет линию-разделитель. */
                   actionMenuItems.addItem(this.getActionsMenuItem({
                       Type: "Terrasoft.MenuSeparator",
                       Caption: ""
                   }));
                   /* Добавляет пункт меню в перечень действий страницы записи. */
                   actionMenuItems.addItem(this.getActionsMenuItem({
                       /* Привязывает заголовок пункта меню к локализуемой строке схемы. */
                       "Caption": { bindTo: "Resources.Strings.CallProcessCaption" },
                       /* Привязывает метод-обработчик действия. */
                       "Tag": "callCustomProcess",
                       /* Привязывает свойство видимости пункта меню к значению, которое возвращает метод isAccountPrimaryContactSet(). */
                       "Visible": { bindTo: "isAccountPrimaryContactSet" }
                   }));
                   return actionMenuItems;
               },
               /* Метод-обработчик действия. */
               callCustomProcess: function() {
                   /* Получает идентификатор основного контакта контрагента. */
                   var contactParameter = this.get("PrimaryContact");
                   /* Объект, который передается в качестве параметра метода executeProcess(). */
                   var args = {
                       /* Имя процесса, который необходимо запустить. */
                       sysProcessName: "UsrCustomProcess",
                       /* Объект со значением входящего параметра ContactParameter для процесса CustomProcess. */
                       parameters: {
                           ProcessSchemaContactParameter: contactParameter.value
                       }
                   };
                   /* Запускает пользовательский бизнес-процесс. */
                   ProcessModuleUtilities.executeProcess(args);
               }
           }
       };
   });
   

4. На панели инструментов дизайнера модуля нажмите Сохранить (Save).

3. Реализовать пользовательское действие страницы раздела 

1. Создать схему замещающей модели представления страницы раздела. Для этого воспользуйтесь инструкцией, которая приведена в статье Добавить действие на страницу записи.
2. Добавьте локализуемую строку с текстом пункта меню, который планируется добавить. Для этого выполните шаг 2 алгоритма создания схемы замещающей модели представления страницы контрагента.

3. Реализуйте логику работы пункта меню. Для этого в свойстве methods реализуйте метод isAccountPrimaryContactSet(), который проверяет наличие основного контакта у выбранного контрагента.

   Исходный код схемы замещающей модели представления страницы раздела представлен ниже.

   AccountSectionV2

   define("AccountSectionV2", [], function() {
       return {
           /* Название схемы страницы раздела. */
           entitySchemaName: "Account",
           /* Методы модели представления страницы раздела. */
           methods: {
               /* Проверяет заполнение поля [Основной контакт] у выбранного контрагента. */
               isAccountPrimaryContactSet: function() {
                   /* Определяет активную запись. */
                   var activeRowId = this.get("ActiveRow");
                   if (!activeRowId) {
                       return false;
                   }
                   /* Получает коллекцию данных списочного представления реестра раздела. Получает модель выбранного контрагента по заданому значению первичной колонки. */
                   var selectedAccount = this.get("GridData").get(activeRowId);
                   if (selectedAccount) {
                       /* Получает свойство модели — основной контакт. */
                       var selectedPrimaryContact = selectedAccount.get("PrimaryContact");
                       /* Возвращает true, если основной контакт заполнен, в другом случае — false. */
                       return selectedPrimaryContact ? true : false;
                   }
                   return false;
               }
           }
       };
   });
   

4. На панели инструментов дизайнера модуля нажмите Сохранить (Save).

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

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

1. Очистите кэш браузера.
2. Обновите страницу раздела Контрагенты (Accounts).

В результате выполнения примера на страницу контрагента добавлено действие Назначить встречу (Schedule a meeting). Это действие активно при наличии основного контакта контрагента.

В результате выбора действия Назначить встречу (Schedule a meeting) запускается пользовательский бизнес-процесс Проведение встречи (Holding a meeting). В качестве параметра бизнес-процесса используется основной контакт контрагента.