formContext.data.process (referência da API do cliente)

O objeto formContext.data.process fornece eventos, métodos e objetos para interagir com os dados de fluxo de processos de negócio num formulário. Para métodos de interação com o controlo de fluxo do processo de negócio no formulário, consulte formContext.ui.process (Referência à API do cliente).

Eventos de processo e métodos de manipulador de eventos

Use os seguintes eventos e métodos de manipulador de eventos para escrever scripts para fluxos de processos de negócios.

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

Métodos de processo ativo

Use esses métodos para recuperar informações sobre o processo ativo e definir um processo diferente como o processo ativo.

Nome Description
getActiveProcess Retorna um objeto Process que representa o processo ativo.
setActiveProcess Define um Processo como o processo ativo.

Métodos de processo

Um processo contém os dados para um fluxo de processo de negócios. Use os métodos para acessar as propriedades do processo.

Nome Description
getId Retorna o identificador exclusivo do processo.
getName Retorna o nome do processo.
getEstágios Retorna uma coleção de etapas do processo.
isRenderizado Retorna um valor booleano indicando se o processo é renderizado.

Métodos ProcessInstance

Use esses métodos para recuperar informações sobre todas as instâncias de processo para um registro e para definir uma instância de processo como a instância ativa.

Nome Description
getProcessInstances Retorna todas as instâncias de processo para o registro de tabela ao qual o usuário chamador tem acesso.
setActiveProcessInstance Define uma instância de processo como a instância ativa.

Métodos de instância

Uma instância de processo contém os dados para uma instância do fluxo do processo de negócios. Use os métodos para acessar as propriedades da instância do processo.

Nome Description
getInstanceId Retorna o identificador exclusivo da instância do processo.
getInstanceName Retorna o nome da instância do processo.
getStatus Retorna o status atual da instância do processo.
setStatus Define o status atual da instância do processo ativo.

Métodos de estágio ativo

Use esses métodos para recuperar informações sobre o estágio ativo e definir um estágio diferente como o estágio ativo.

Nome Description
getActiveStage Retorna um objeto Stage que representa o estágio ativo.
setActiveStage Define um estágio concluído como o estágio ativo.

Métodos de estágio

Um estágio contém os dados de um estágio em um fluxo de processo de negócios. Use os métodos para acessar as propriedades do palco.

Nome Description
getCategory Retorna um objeto com um método getValue que retornará o valor inteiro da categoria de fluxo do processo comercial.
getEntityName Retorna o nome lógico da tabela associada ao palco.
getId Retorna o identificador exclusivo do estágio.
getName Retorna o nome do estágio.
getNavigationBehavior Retorna um objeto de comportamento de navegação para um estágio que pode ser usado para definir se o botão Criar está disponível para que os usuários criem outro registro de tabela em um cenário de navegação de fluxo de processo comercial entre tabelas.
getStatus Retorna o status do estágio.
getSteps Retorna uma coleção de etapas no estágio.

Métodos de passo

Uma etapa contém os dados de uma etapa em um estágio em um fluxo de processo de negócios. Use os métodos para acessar as propriedades da etapa.

Nome Description
getAttribute Retorna o nome lógico da coluna associada à etapa.
getName Retorna o nome da etapa.
getProgress Retorna o progresso da etapa de ação.
isObrigatório Retorna um valor booleano que indica se a etapa é necessária no fluxo do processo comercial.
setProgress Atualiza o progresso da etapa de ação.

Use estes métodos para avançar para as fases seguintes e anteriores. Ambos os métodos desencadeiam o OnStageChange evento.

Nome Description
moverSeguinte Avança para a fase seguinte.
moverAnterior Passa para a fase anterior.

Outros métodos úteis

Use esses métodos para encontrar informações sobre os estágios no caminho ativo, os processos habilitados e o estágio selecionado.

Nome Description
getActivePath Obtém uma coleção de estágios atualmente no caminho ativo com métodos para interagir com os estágios exibidos no controle de fluxo do processo de negócios.
getEnabledProcesses Recupera de forma assíncrona os fluxos do processo de negócios habilitados para uma tabela para a qual o usuário atual pode alternar.
getSelectedStage Obtém o estágio selecionado no momento.

formContext.ui.process (referência da API do cliente)
Compreender o modelo de objeto Xrm
Controles (referência da API do cliente)

  • Última atualização a