Заметка
Доступ к этой странице требует авторизации. Вы можете попробовать войти в систему или изменить каталог.
Доступ к этой странице требует авторизации. Вы можете попробовать сменить директорию.
Предоставляет события, методы и объекты для взаимодействия с данными потока бизнес-процессов в форме. Сведения о методах взаимодействия с элементом управления потоком бизнес-процессов в форме см. в статье formContext.ui.process.process(справочник по API клиента).
Обработка событий и методов обработчика событий
Используйте следующие события и методы обработчика событий для записи скриптов для потоков бизнес-процессов.
Методы активного процесса
Используйте эти методы для получения сведений об активном процессе и задания другого процесса в качестве активного процесса.
| Имя | Description |
|---|---|
| getActiveProcess | Возвращает объект Process , представляющий активный процесс. |
| setActiveProcess | Задает процесс в качестве активного процесса. |
Методы обработки
Процесс содержит данные для потока бизнес-процессов. Используйте методы для доступа к свойствам процесса.
| Имя | Description |
|---|---|
| getId | Возвращает уникальный идентификатор процесса. |
| getName | Возвращает имя процесса. |
| GetStages | Возвращает коллекцию этапов процесса. |
| isRendered | Возвращает логическое значение, указывающее, выполняется ли отрисовка процесса. |
Методы ProcessInstance
Используйте эти методы для получения сведений обо всех экземплярах процесса для записи и задания экземпляра процесса в качестве активного экземпляра.
| Имя | Description |
|---|---|
| getProcessInstances | Возвращает все экземпляры процесса для записи таблицы, к которому имеет доступ вызывающий пользователь. |
| setActiveProcessInstance | Задает экземпляр процесса в качестве активного экземпляра. |
Методы экземпляра
Экземпляр процесса содержит данные для экземпляра потока бизнес-процессов. Используйте методы для доступа к свойствам экземпляра процесса.
| Имя | Description |
|---|---|
| getInstanceId | Возвращает уникальный идентификатор экземпляра процесса. |
| getInstanceName | Возвращает имя экземпляра процесса. |
| getStatus | Возвращает текущее состояние экземпляра процесса. |
| setStatus | Задает текущее состояние активного экземпляра процесса. |
Методы Активного этапа
Используйте эти методы для получения сведений о активной стадии и задания другого этапа в качестве активного этапа.
| Имя | Description |
|---|---|
| getActiveStage | Возвращает объект Stage , представляющий активный этап. |
| setActiveStage | Задает завершенный этап в качестве активного этапа. |
Методы этапов
Этап содержит данные для этапа в потоке бизнес-процессов. Используйте методы для доступа к свойствам этапа.
| Имя | Description |
|---|---|
| getCategory | Возвращает объект с методом getValue , который возвращает целочисленное значение категории потока бизнес-процессов. |
| getEntityName | Возвращает логическое имя таблицы, связанной с этапом. |
| getId | Возвращает уникальный идентификатор этапа. |
| getName | Возвращает имя этапа. |
| getNavigationBehavior | Возвращает объект поведения навигации для этапа, который можно использовать для определения доступности кнопки "Создать " для пользователей для создания другой записи таблицы в сценарии навигации потока бизнес-процессов между таблицами. |
| getStatus | Возвращает состояние этапа. |
| getSteps | Возвращает коллекцию шагов на этапе. |
Методы шага
Шаг содержит данные для шага на этапе в потоке бизнес-процессов. Используйте методы для доступа к свойствам шага.
| Имя | Description |
|---|---|
| getAttribute | Возвращает логическое имя столбца, связанного с шагом. |
| getName | Возвращает имя шага. |
| getProgresss | Возвращает ход выполнения шага действия. |
| isRequired | Возвращает логическое значение, указывающее, требуется ли шаг в потоке бизнес-процессов. |
| setProgres | Обновляет ход выполнения шага действия. |
Методы навигации
Используйте эти методы для перехода к следующим и предыдущим этапам. Оба этих метода вызывают событие OnStageChange.
| Имя | Description |
|---|---|
| moveNext | Выполняется до следующего этапа. |
| movePrevious | Переходит к предыдущему этапу. |
Другие полезные методы
Используйте эти методы, чтобы найти сведения о этапах активного пути, включенных процессах и выбранном этапе.
| Имя | Description |
|---|---|
| getActivePath | Возвращает коллекцию этапов в активном пути с методами взаимодействия с этапами, отображаемыми в элементе управления потоком бизнес-процессов. |
| getEnabledProcesses | Асинхронно извлекает потоки бизнес-процессов, включенные для таблицы, в которую текущий пользователь может переключаться. |
| getSelectedStage | Возвращает выбранный в данный момент этап. |
Связанные статьи
formContext.ui.process (справочник по API клиента)
Общие сведения об объектной модели Xrm
Элементы управления (справочник по клиентскому API)