formContext.data.process (referencia de la API de cliente)

  • Artículo

Proporciona eventos, métodos y objetos para interactuar con los datos del flujo de proceso de negocio en un formulario. Vea formContext.ui.process (referencia de la API de cliente) para métodos para interactuar con el control de flujo de proceso de negocio en el formulario.

Métodos de controlador de eventos y procesos de eventos

Utilice los siguientes eventos y métodos de controlador de eventos para escribir secuencias para flujos de procesos de negocio.

Evento Métodos de controlador de eventos
OnPreProcessStatusChange addOnPreProcessStatusChange
removeOnPreProcessStatusChange
OnProcessStatusChange addOnProcessStatusChange
removeOnProcessStatusChange
Evento OnPreStageChange addOnPreStageChange
removeOnPreStageChange
OnStageChange addOnStageChange
removeOnStageChange
OnStageSelected addOnStageSelected
removeOnStageSelected

Métodos de proceso activo

Use estos métodos para recuperar información sobre el proceso activo y para definir otro proceso como proceso activo.

Nombre Descripción
getActiveProcess Devuelve un objeto de Proceso que representa el proceso activo.
setActiveProcess Define una Proceso como proceso activo.

Métodos de proceso

Un proceso contiene los datos para un flujo de proceso de negocio. Uso los métodos para obtener acceso a las propiedades del proceso.

Nombre Descripción
getId Devuelve el identificador único del proceso.
getName Devuelve el nombre del proceso.
getStages Devuelve una colección de fases del proceso.
isRendered Devuelve un valor booleano que indica si el proceso se ha representado.

Métodos ProcessInstance

Use estos métodos para recuperar información sobre todas las instancias de un proceso para un registro y para establecer una instancia de proceso como instancia activa.

Nombre Descripción
getProcessInstances Devuelve todas las instancias del proceso para el registro de la tabla al que tiene acceso el usuario que hace la llamada.
setActiveProcessInstance Define una instancia de proceso como instancia activa.

Método de instancia

Una instancia de proceso contiene los datos para una instancia del flujo de proceso de negocio. Uso los métodos para obtener acceso a las propiedades de la instancia de proceso.

Nombre Descripción
getInstanceId Devuelve el identificador único de la instancia de proceso.
getInstanceName Devuelve el nombre de la instancia de proceso.
getStatus Devuelve el estado actual de la instancia de proceso.
setStatus Establece el estado actual de la instancia de proceso activa.

Métodos de fase activa

Use estos métodos para recuperar la información sobre la fase activa y para establecer otra fase como la fase activa.

Nombre Descripción
getActiveStage Devuelve un objeto de Fase que representa la fase activa.
setActiveStage Establece una fase completada como fase activa.

Métodos de fase

Una fase contiene los datos para una fase en un flujo de proceso de negocio. Uso los métodos para obtener acceso a las propiedades de la fase.

Nombre Descripción
getCategory Devuelve un objeto con un método getValue que devuelve el valor entero de la categoría del flujo de proceso de negocio.
getEntityName Devuelve el nombre lógico de la tabla asociada con la fase.
getId Devuelve el identificador único de la fase.
getName Devuelve el nombre de la fase.
getNavigationBehavior Devuelve un objeto de comportamiento de navegación para una fase que se puede utilizar para definir si el botón Crear estará disponible para que los usuarios creen otro registro de tabla en un escenario de navegación del flujo de proceso de negocio con varias tablas.
getStatus Devuelve el estado de la fase.
getSteps Devuelve una colección de pasos de la fase.

Métodos de paso

Un paso contiene los datos para un paso de una fase de un flujo de proceso de negocio. Uso los métodos para obtener acceso a las propiedades del paso.

Nombre Descripción
getAttribute Devuelve el nombre lógico de la columna asociada al paso.
getName Devuelve el nombre del paso.
getProgress Devuelve el progreso del paso de acción.
isRequired Devuelve un valor booleano que indica si el paso es obligatorio en el flujo de proceso de negocio.
setProgress Actualiza el progreso del paso de acción.

Utilice estos métodos para desplazarse a etapas anteriores y siguientes. Ambos métodos harán que se produzca el evento OnStageChange.

Nombre Descripción
moveNext Avanza a la siguiente fase.
movePrevious Retrocede a la fase anterior.

Otros métodos útiles

Utilice estos métodos para obtener información sobre las fases en la ruta activa, procesos habilitados y fase seleccionada.

Nombre Descripción
getActivePath Obtiene una colección de fases actualmente en la ruta activa con métodos para interactuar con las fases mostradas en el control de flujo de proceso de negocio.
getEnabledProcesses Recupera de forma asincrónica los flujos de procesos de negocio habilitados para una tabla a la que se puede cambiar el usuario.
getSelectedStage Obtiene la fase seleccionada actual.

formContext.ui.process (referencia de la API de cliente)
Comprender el modelo de objetos XRM
Controles (referencia de la API de cliente)

Nota

¿Puede indicarnos sus preferencias de idioma de documentación? Realice una breve encuesta. (tenga en cuenta que esta encuesta está en inglés)

La encuesta durará unos siete minutos. No se recopilan datos personales (declaración de privacidad).