formContext.data.process (препратка към API на клиент)

Предоставя събития, методи и обекти за взаимодействие с данните за потока на бизнес процеса във формуляр. Вижте formContext.ui.process (препратка към API на клиент) за методи за взаимодействие с контролата на потока на бизнес процеса във формуляра.

Обработка на събития и методи на манипулатора на събития

Използвайте следните събития и методи на манипулатора на събития, за да пишете скриптове за потоци на бизнес процеси.

Събитие	Методи на манипулатора на събития
OnPreProcessStatusChange	addOnPreProcessStatusChange removeOnPreProcessStatusChange
OnProcessStatusChange	addOnProcessStatusChange removeOnProcessStatusChange
OnPreStageChange	Промяна на addOnPreStage removeOnPreStageChange
OnStageChange	Изображение на бутон removeOnStageChange
OnStageSelected	AddOnStageИзбрано removeOnStageИзбрано

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

Използвайте тези методи, за да извлечете информация за активния процес и да зададете различен процес като активен процес.

Име	Описание
getActiveProcess	Връща обект Process, представляващ активния процес.
setActiveProcess	Задава процес като активен процес.

Методи на процеса

Процесът съдържа данните за поток на бизнес процес. Използвайте методите за достъп до свойствата на процеса.

Име	Описание
getId	Връща еднозначния идентификатор на процеса.
getName	Връща името на процеса.
getStages	Връща колекция от етапи в процеса.
е рендиран	Връща булева стойност, показваща дали процесът се рендира.

Методи processInstance

Използвайте тези методи, за да извлечете информация за всички екземпляри на процеса за запис и да зададете екземпляр на процес като активен екземпляр.

Име	Описание
getProcessInstances	Връща всички екземпляри на процеса за записа на таблицата, до който повикващият потребител има достъп.
setActiveProcessInstance	Задава екземпляр на процес като активен екземпляр.

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

Екземплярът на процес съдържа данните за екземпляр на потока на бизнес процеса. Използвайте методите за достъп до свойствата на екземпляра на процеса.

Име	Описание
getInstanceId	Връща еднозначния идентификатор на екземпляра на процеса.
getInstanceName	Връща името на екземпляра на процеса.
getStatus	Връща текущото състояние на екземпляра на процеса.
setStatus	Задава текущото състояние на екземпляра на активния процес.

Методи на Активния етап

Използвайте тези методи, за да извлечете информация за активния етап и да зададете различен етап като активен етап.

Име	Описание
getActiveStage	Връща обект Stage , представляващ активния етап.
setActiveStage	Задава завършен етап като активен етап.

Методи на етапа

Един етап съдържа данните за етап в поток на бизнес процес. Използвайте методите за достъп до свойствата на етапа.

Име	Описание
getCategory	Връща обект с метод getValue , който ще върне цялата стойност на категорията на потока на бизнес процеса.
getEntityName	Връща логическото име на таблицата, свързана с етапа.
getId	Връща еднозначния идентификатор на етапа.
getName	Връща името на етапа.
getNavigationBehavior	Връща обект на поведение на навигация за етап, който може да се използва, за да се определи дали бутонът Създаване е наличен за потребителите за създаване на друг запис на таблица в сценарий за навигация между таблици на поток на бизнес процес.
getStatus	Връща състоянието на етапа.
получаване на стъпки	Връща колекция от стъпки в етапа.

Методи на стъпки

Стъпката съдържа данните за стъпка в етап в поток на бизнес процес. Използвайте методите за достъп до свойствата на стъпката.

Име	Описание
getAttribute	Връща логическото име на колоната, свързана със стъпката.
getName	Връща името на стъпката.
getProgress	Връща напредъка на стъпката от действието.
се изисква	Връща булева стойност, показваща дали стъпката е задължителна в потока на бизнес процеса.
setProgress	Актуализира напредъка на стъпката от действието.

Методи за навигация

Използвайте тези методи, за да преминете към следващи и предишни етапи. И двата метода ще доведат до възникване на събитиеТо OnStageChange.

Име	Описание
moveNext	Отива на следващия етап.
movePrevious	Преминава към предишния етап.

Други полезни методи

Използвайте тези методи, за да намерите информация за етапите в активния път, разрешените процеси и избрания етап.

Име	Описание
getActivePath	Получава колекция от етапи, които в момента са в активния път, с методи за взаимодействие с етапите, показани в контролата на потока на бизнес процеса.
getEnabledProcesses	Асинхронно извлича потоците на бизнес процеса, разрешени за таблица, към която текущият потребител може да превключи.
getSelectedStage	Получава текущо избрания етап.

Свързани статии

formContext.ui.process (препратка към API на клиент)
Разбиране на обектния модел на Xrm
Контроли (препратка към API на клиент)