formContext.data.process (посилання на API клієнта)

Надає події, методи та об'єкти для взаємодії з даними потоку бізнес-процесів у формі. Методи взаємодії з елементами керування потоком бізнес-процесів у формі див. в статті formContext.ui.process (довідник із API клієнта).

Способи обробки подій і подій

Щоб записати сценарії для потоків бізнес-процесів, скористайтеся наведеними нижче методами подій і обробником подій.

Подія	Методи обробника подій
OnPreProcessStatusChange	addOnPreProcessStatusChange removeOnPreProcessStatusChange
OnProcessStatusChange	addOnProcessStatusChange removeOnProcessStatusChange
OnPreStageChange	addOnPreStageChange removeOnPreStageChange
Змінення подання onStage	addOnStageChange видалитиonStageChange
OnStageSelected	addOnStageSelected removeOnStageSelected

Методи активного процесу

Скористайтеся цими методами, щоб отримати відомості про активний процес і встановити інший процес як активний процес.

Ім'я	Опис
getActiveProcess	Повертає об'єкт Process , який представляє активний процес.
setActiveProcess	Визначає процес як активний процес.

Методи процесу

Процес містить дані для потоку бізнес-процесів. Використовуйте методи для доступу до властивостей процесу.

Ім'я	Опис
getId (ідентифікатор)	Повертає унікальний ідентифікатор процесу.
getName	Повертає ім'я процесу.
getStages	Повертає колекцію етапів процесу.
isRendered	Повертає логічне значення, яке вказує, чи відтворюється процес.

Методи processInstance

Скористайтеся цими методами, щоб отримати відомості про всі екземпляри процесу для запису та встановити екземпляр процесу як активний екземпляр.

Ім'я	Опис
getProcessInstances	Повертає всі екземпляри процесу для запису таблиці, до яких користувач, який викликає виклик, має доступ.
setActiveProcessInstance	Установлює екземпляр процесу як активний екземпляр.

Методи екземпляра

Екземпляр процесу містить дані екземпляра потоку бізнес-процесів. Використовуйте методи для доступу до властивостей екземпляра процесу.

Ім'я	Опис
getInstanceId	Повертає унікальний ідентифікатор екземпляра процесу.
getInstanceName	Повертає ім'я екземпляра процесу.
getStatus	Повертає поточний стан екземпляра процесу.
setStatus (Установити статистику)	Установлює поточний стан екземпляра активного процесу.

Методи Active Stage

Скористайтеся цими методами, щоб отримати відомості про активну стадію та встановити іншу стадію як активну стадію.

Ім'я	Опис
getActiveStage	Повертає об'єкт Stage , що представляє активну стадію.
setActiveStage	Установлює завершену стадію як активну стадію.

Методи стадії

Етап містить дані для стадії в процесі бізнес-процесу. Використовуйте методи для доступу до властивостей стадії.

Ім'я	Опис
отриматикатегорії	Повертає об'єкт із методом getValue , який повертає ціле значення категорії потоку бізнес-процесів.
getEntityName	Повертає логічне ім'я таблиці, пов'язаної зі сценою.
getId (ідентифікатор)	Повертає унікальний ідентифікатор етапу.
getName	Повертає ім'я стадії.
getNavigationBehavior	Повертає об'єкт поведінки навігації для етапу, який можна використовувати, щоб визначити, чи доступна кнопка Створити для користувачів для створення іншого запису таблиці в сценарії навігації між таблицями бізнес-процесів.
getStatus	Повертає стан стадії.
getSteps	Повертає колекцію кроків на стадії.

Кроки

Крок містить дані для кроку в стадії потоку бізнес-процесів. Скористайтеся методами, щоб отримати доступ до властивостей кроку.

Ім'я	Опис
getAttribute	Повертає логічне ім'я стовпця, пов'язаного з етапом.
getName	Повертає ім'я кроку.
getProgress	Повертає перебіг виконання кроку дії.
isRequired	Повертає логічне значення, яке вказує, чи потрібен крок у потоці бізнес-процесів.
setProgress	Оновлення перебігу виконання кроку дії.

Способи навігації

Використовуйте ці методи для переходу до наступної та попередньої стадій. Обидва ці методи спричинятимуть появу події OnStageChange.

Ім'я	Опис
moveNext	Перебіг до наступного етапу.
перемістити до попереднього	Перехід до попереднього етапу.

Інші корисні методи

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

Ім'я	Опис
getActivePath	Отримує колекцію стадій, які зараз є активним шляхом, за допомогою методів взаємодії з етапами, які відображаються в елементі керування потоком бізнес-процесів.
getEnabledProcesses	Асинхронно отримує потоки бізнес-процесів, увімкнуті для таблиці, до яких може перейти поточний користувач.
getSelectedStage	Отримує вибрану стадію.

Пов’язані статті

formContext.ui.process (посилання на API клієнта)
Загальні відомості про об'єктні моделі Xrm
Елементи керування (довідник із інтерфейсу API клієнта)