Xrm.Page.data.process (referência do cliente)

  • Artigo

 

Publicado: janeiro de 2017

Aplicável a: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

O namespace Xrm.Page.data.process fornece eventos, métodos e objetos para interagir com os dados do fluxo de processo empresarial em um formulário.

Consulte Xrm.Page.ui.process (referência do cliente) para métodos para interagir com o controle de fluxo do processo empresarial no formulário.

Métodos Xrm.Page.data.process

  • Métodos ActiveProcess
    Use getActiveProcess para recuperar informações sobre o processo ativo e setActiveProcess para definir um processo diferente como o processo ativo.

  • Métodos de ProcessInstance
    Use getProcessInstances para recuperar informações sobre todas as instâncias do processo de um registro da entidade e use setActiveProcessInstance para definir uma instância do processo como a instância ativa.

  • Métodos ActiveStage
    Use getActiveStage para recuperar informações sobre o estágio ativo e setActiveStage para definir um estágio concluído como o estágio ativo.

    Você pode usar o setActiveStage para um estágio em uma entidade diferente.

  • getActivePath
    Use este método para obter um conjunto de etapas atualmente no caminho ativo com métodos para interagir com os estágios exibidos no controle de fluxo do processo empresarial.

    O caminho ativo representa estágios atualmente renderizados no controle do processo com base nas regras de ramificação e nos dados atuais no registro.

  • getEnabledProcesses
    Use este método para recuperar de maneira assíncrona os fluxos do processo empresarial habilitados que o usuário poderá alternar para uma entidade.

  • getSelectedStage
    Use esse método para acessar o estágio atualmente selecionado.

  • Métodos para gerenciar manipuladores de eventos
    Use os métodos addOnStageChange, removeOnStageChange, addOnStageSelected, removeOnStageSelected, addOnProcessStatusChange, and removeOnProcessStatusChange para adicionar ou remover manipuladores de eventos para o controle de fluxo do processo empresarial.

  • Métodos de navegação
    Use moveNext para mover para o próximo estágio e movePrevious para mover para o estágio anterior.

    Você pode usar o movePrevious para um estágio anterior em uma entidade diferente.

  • Métodos de processo
    Use os métodos de processo para acessar propriedades do processo.

  • Métodos da instância
    Use os métodos de instância do processo para acessar as propriedades da instância do processo atual.

  • Métodos do estágio
    Use métodos de estágios para acessar propriedades do estágio em um fluxo de processos empresariais.

  • Métodos da etapa
    Use métodos de etapa para acessar propriedades da etapa em um estágio no fluxo de processos empresariais.

Métodos ActiveProcess

Use getActiveProcess para recuperar informações sobre o processo ativo e setActiveProcess para definir um processo diferente como o processo ativo.

getActiveProcess

Retorna um objeto Process que representa o processo ativo.

var activeProcess = Xrm.Page.data.process.getActiveProcess();

  • Valor de Retorno
    Tipo: Processo

    Comentários: Consulte Métodos de processo para os métodos para acessar as propriedades do processo devolvido.

setActiveProcess

Defina um Process como o processo ativo.

Se houver uma instância do processo ativa, o registro da entidade será carregado com a ID da instância. Se não houver uma instância do processo atual ativa, uma nova instância do processo será criada e o registro da entidade será carregado com a ID da instância. Se houver várias instâncias do processo atual, o registro será carregado com a primeira instância do processo ativa de acordo com a lógica padrão, que é a instância do processo usada mais recentemente por usuário.

Xrm.Page.data.process.setActiveProcess(processId, callbackFunction);

Parâmetros:

  • processId
    Digite:String

    Comentários: A Id do processo para simplificar o processo ativo.

  • callbackFunction
    Tipo:Function

    Comentários: Uma função para chamar quando a operação for concluída. Essa função de retorno de chamadas é passada por um dos valores de sequência a seguir para indicar se a operação foi bem-sucedida.

    Valor

    Descrição

    Sucesso

    A operação foi bem-sucedida.

    Inválido

    O processId não é válido ou o processo não foi habilitado.

Métodos de ProcessInstance

Use getProcessInstances para recuperar informações sobre todas as instâncias do processo de um registro da entidade e use setActiveProcessInstance para definir uma instância do processo como a instância ativa.

Observação

Esses métodos foram introduzidos no Atualização de dezembro de 2016 para Dynamics 365 (online e local).

getProcessInstances

Retorna todas as instâncias do processo para o registro da entidade ao qual o usuário que chamou tem acesso.

Xrm.Page.data.process.getProcessInstances(callbackFunction(object));

  • Parâmetro
    Digite:Function

    Comentários: a função de retorno de chamada tem um objeto passado com os atributos a seguir e seus valores correspondentes como o par chave:valor.

    • CreatedOn

    • ProcessDefinitionID

    • ProcessDefinitionName

    • ProcessInstanceID

    • ProcessInstanceName

    • StatusCodeName

    As instâncias do processo são filtradas de acordo com os privilégios do usuário.

setActiveProcessInstance

Define a instância do processo como a instância ativa.

Xrm.Page.data.process.setActiveProcessInstance(processInstanceId, callbackFunction);

Parâmetros:

  • processInstanceId
    Digite:String

    Comentários: a Id da instância do processo a ser definida como a instância ativa.

  • callbackFunction
    Digite:Function

    Comentários: Uma função para chamar quando a operação for concluída. Essa função de retorno de chamadas é passada por um dos valores de sequência a seguir para indicar se a operação foi bem-sucedida.

    Valor

    Descrição

    Sucesso

    A operação foi bem-sucedida.

    Inválido

    O processInstanceId não é válido ou o processo não foi habilitado.

Métodos ActiveStage

Use getActiveStage para recuperar informações sobre o estágio ativo e setActiveStage para definir um estágio diferente como o estágio ativo.

getActiveStage

Retorna um objeto Stage que representa o estágio ativo.

var activeStage = Xrm.Page.data.process.getActiveStage();

  • Valor de Retorno
    Tipo: Estágio

    Comentários: Consulte Métodos do estágio para os métodos para acessar as propriedades do estágio devolvido.

setActiveStage

Defina um estágio concluído como o estágio ativo.

Observação

Depois do Atualização 1 do Microsoft Dynamics CRM Online 2015, você pode usar esse método para definir um estágio em uma entidade diferente.

Somente um estágio concluído para a entidade pode ser configurado usando este método.

Xrm.Page.data.process.setActiveStage(stageId, callbackFunction);

Parâmetros:

  • stageId
    Tipo:String

    Comentários: O ID do estágio concluído para a entidade para tornar o estágio ativo.

  • callbackFunction
    Tipo:Function

    Comentários: Uma função opcional para chamar quando a operação for concluída.

    A função de retorno de chamada será transmitida com um valor de sequência de “success", se a operação for concluída com êxito.

    Se stageId representa um estágio que não é válido, o estágio não poderá se tornar ativo e a função de retorno de chamada será transmitida por um valor de sequência indicando a razão. Os valores listados na tabela a seguir podem ser retornados.

    Valor

    Razão

    invalid

    Há três motivos pelos quais esse valor pode ser retornado:

    • O parâmetro de stageId é um valor de ID de estágio inexistente.

    • O estágio ativo não é o estágio selecionado

    • O registro ainda não foi salvo.

    unreachable

    O estágio existe um caminho diferente.

    dirtyForm

    Esse valor será retornado se os dados na página não forem salvos.

    Importante

    Esse método pode ser usado somente quando o estágio selecionado e o estágio ativo forem o mesmo. Quando o código for iniciado no d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange, o estágio atual estará selecionado. Quando o seu código for iniciado do d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageSelected, você deve usar Xrm.Page.data.process.getActiveStage para verificar se o estágio selecionado também é o estágio ativo. Para qualquer outro tipo de evento do formulário, não é possível determinar qual estágio está atualmente selecionado. Para obter melhores resultados, este método deve ser usado somente no código chamado em funções iniciadas por eventos de OnStageChange e OnStageSelected.

getActivePath

Use este método para obter um conjunto de etapas atualmente no caminho ativo com métodos para interagir com os estágios exibidos no controle de fluxo do processo empresarial.

O caminho ativo representa estágios atualmente renderizados no controle do processo com base nas regras de ramificação e nos dados atuais no registro.

var stageCollection = Xrm.Page.data.process.getActivePath();

Exemplo:

Consulte Exemplo: Xrm.Page.data.process.getActivePath para o exemplo usando esse método.

  • Valor de Retorno
    Tipo: Coleção

    Remarks: Um conjunto de todos os estágios concluídos, o estágio ativo atualmente e o conjunto previsto de estágios futuros com base nas condições atendidas na regra de ramificação. Isso pode ser um subconjunto de estágios retornado com Xrm.Page.data.process. getActiveProcess porque incluirá somente os estágios que representam uma transição válida do estágio atual com base na ramificação ocorrida no processo.

getEnabledProcesses

Use este método para recuperar de maneira assíncrona os fluxos do processo empresarial habilitados que o usuário poderá alternar para uma entidade.

Xrm.Page.data.process.getEnabledProcesses(callbackFunction(enabledProcesses));

  • Parâmetro
    Tipo:Function

    Comentários: A função de chamada deve aceitar um parâmetro que contenha um objeto com propriedades de dicionário onde o nome da propriedade é a Id do fluxo de processo empresarial e o valor da propriedade é o nome do fluxo de processos empresarial.

    Os processos habilitados são filtrados de acordo com os privilégios do usuário. A lista de dos processos habilitados é a mesma que um usuário pode ver na interface do usuário se quiser alterar o processo manualmente.

    Exemplo:

    Consulte Exemplo: Xrm.Page.data.process.getEnabledProcesses para um exemplo usando esse método.

getSelectedStage

Use esse método para obter o estágio atualmente selecionado.

Xrm.Page.data.process.getSelectedStage()

  • Valor de Retorno
    Tipo: Estágio

    O estágio atualmente selecionado.

  • Comentários
    Consulte Métodos do estágio para os métodos para acessar as propriedades do estágio retornado.

Métodos para gerenciar manipuladores de eventos

Use esses métodos para adicionar ou remover manipuladores de eventos para o controle de fluxo do processo empresarial.

addOnStageChange

Use essa opção para adicionar uma função como um manipulador de eventos para o d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange de modo que será chamado quando o estágio do fluxo de processo empresarial é alterado.

Xrm.Page.data.process.addOnStageChange(handler);

  • Parâmetro
    Tipo: referência de função

    Remarks: A função será adicionada à parte inferior do pipeline da manipulador de eventos. O contexto de execução é definido automaticamente como o primeiro parâmetro passado para o manipulador de eventos. Consulte Contexto de execução (referência do cliente) para obter mais informações.

    É necessário usar uma referência para uma função nomeada em vez de uma função anônima se você quiser posteriormente remover o manipulador de eventos.

removeOnStageChange

Use isso para remover uma função como um manipulador de eventos para o d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange.

Xrm.Page.data.process.removeOnStageChange(handler);

  • Parâmetro
    Tipo: referência de função

    Remarks: Se uma função anônima é definida usando o método addOnStageChange ele não poderá ser removido usando este método.

addOnStageSelected

Use essa opção para adicionar uma função como um manipulador de eventos para o d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageSelected de modo que será chamado quando o estágio do fluxo de processo empresarial é selecionado.

Xrm.Page.data.process.addOnStageSelected(handler);

  • Parâmetro
    Tipo: referência de função

    Remarks: A função será adicionada à parte inferior do pipeline da manipulador de eventos. O contexto de execução é definido automaticamente como o primeiro parâmetro passado para o manipulador de eventos. Consulte Contexto de execução (referência do cliente) para obter mais informações.

    É necessário usar uma referência para uma função nomeada em vez de uma função anônima se você quiser posteriormente remover o manipulador de eventos.

removeOnStageSelected

Use isso para remover uma função como um manipulador de eventos para o d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageSelected.

Xrm.Page.data.process.removeOnStageSelected(function reference);

  • Parâmetro
    Tipo: referência de função

    Remarks: Se uma função anônima é definida usando o método addOnStageSelected ele não poderá ser removido usando este método.

addOnProcessStatusChange

Use essa opção para adicionar uma função como um manipulador de eventos para o evento d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnProcessStatusChange, de modo que ele seja chamado quando o fluxo do processo empresarial for alterado.

Xrm.Page.data.process.addOnProcessStatusChange(handler);

  • Parâmetro
    Tipo: referência de função

    Remarks: A função será adicionada à parte inferior do pipeline da manipulador de eventos. O contexto de execução é definido automaticamente como o primeiro parâmetro passado para o manipulador de eventos. Consulte Contexto de execução (referência do cliente) para obter mais informações.

    É necessário usar uma referência para uma função nomeada em vez de uma função anônima se você quiser posteriormente remover o manipulador de eventos.

    Esse método foi apresentado no Atualização de dezembro de 2016 para Dynamics 365 (online e local).

removeOnProcessStatusChange

Use isso para remover uma função como um manipulador de eventos para o evento d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnProcessStatusChange.

Xrm.Page.data.process.removeOnProcessStatusChange(handler);

  • Parâmetro
    Tipo: referência de função

    Remarks: Se uma função anônima é definida usando o método addOnProcessStatusChange ele não poderá ser removido usando este método.

    Esse método foi apresentado no Atualização de dezembro de 2016 para Dynamics 365 (online e local).

Métodos de navegação

Use moveNext para mover para o próximo estágio e movePrevious para mover para o estágio anterior. Os dois métodos causará a ocorrência do d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange.

moveNext

Avança para o próximo estágio.

Xrm.Page.data.process.moveNext(callbackFunction);

  • Parâmetro
    Tipo: Função

    Comentários: Uma função opcional para chamar quando a operação for concluída. Essa função de retorno de chamadas é passada por um dos valores de sequência a seguir para indicar se a operação foi bem-sucedida.

    Valor

    Descrição

    Sucesso

    A operação foi bem-sucedida.

    crossEntity

    O próximo estágio é para uma entidade diferente.

    Término

    O estágio ativo é o último estágio do caminho ativo.

    Inválido

    A operação falhou porque o estágio selecionado não é o mesmo do estágio ativo.

    dirtyForm

    Esse valor será retornado se os dados na página não forem salvos.

Importante

Esse método pode ser usado somente quando o estágio selecionado e o estágio ativo forem o mesmo. Quando o código for iniciado no d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange, o estágio atual estará selecionado. Quando o seu código for iniciado do d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageSelected, você deve usar Xrm.Page.data.process.getActiveStage para verificar se o estágio selecionado também é o estágio ativo. Para qualquer outro tipo de evento do formulário, não é possível determinar qual estágio está atualmente selecionado. Para obter melhores resultados, este método deve ser usado somente no código chamado em funções iniciadas por eventos de OnStageChange e OnStageSelected.

movePrevious

Move para o estágio anterior. Você pode usar movePrevious para um estágio anterior em uma entidade diferente.

Xrm.Page.data.process.movePrevious(callbackFunction);

  • Parâmetro
    Tipo: Função

    Comentários: Uma função opcional para chamar quando a operação for concluída. Essa função de retorno de chamadas é passada por um dos valores de sequência a seguir para indicar se a operação foi bem-sucedida.

    Valor

    Descrição

    Sucesso

    A operação foi bem-sucedida.

    crossEntity

    O estágio anterior é para uma entidade diferente.

    Início

    O estágio ativo é o primeiro estágio do caminho ativo.

    Inválido

    A operação falhou porque o estágio selecionado não é o mesmo do estágio ativo.

    dirtyForm

    Esse valor será retornado se os dados na página não forem salvos.

Importante

Esse método pode ser usado somente quando o estágio selecionado e o estágio ativo forem o mesmo. Quando o código for iniciado no d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageChange, o estágio atual estará selecionado. Quando o seu código for iniciado do d88d5f21-6385-443b-91f2-0ec0c16b1324#BKMK_OnStageSelected, você deve usar Xrm.Page.data.process.getActiveStage para verificar se o estágio selecionado também é o estágio ativo. Para qualquer outro tipo de evento do formulário, não é possível determinar qual estágio está atualmente selecionado. Para obter melhores resultados, este método deve ser usado somente no código chamado em funções iniciadas por eventos de OnStageChange e OnStageSelected.

Observação

Você pode usar esse método para voltar para um estágio em uma entidade diferente.

Métodos de processo

Um processo contém os dados para um fluxo de processos empresarial. Use os métodos para acessar propriedades do processo.

getId

Retorna o identificador exclusivo do processo

var processId = procObj.getId();

  • Valor de Retorno
    Tipo:String

    Comentários: O valor representa a representação da cadeia de caracteres do valor GUID.

getName

Retorna o nome do processo

var processName = procObj.getName();
  • Valor de Retorno
    Tipo:String

getStages

Retorna um conjunto de estágios no processo

var stageCollection = procObj.getStages();

  • Valor de Retorno
    Tipo: coleção

    Consulte Métodos do estágio para os métodos para acessar as propriedades dos estágios devolvidos.

isRendered

Retorna true se o processo for renderizado, falso se não for renderizado

var processRendered = procObj.isRendered();

Métodos da instância

Uma instância do processo contém os dados para uma instância do fluxo do processo empresarial. Use os métodos para acessar propriedades da instância do processo.

Observação

Os métodos da instância foram introduzidos no Atualização de dezembro de 2016 para Dynamics 365 (online e local).

getInstanceId

Retorna o identificador exclusivo da instância do processo

Xrm.Page.data.process.getInstanceId();

  • Valor de Retorno
    Digite:String

    Comentários: O valor representa a representação da cadeia de caracteres do valor GUID.

getInstanceName

Retorna o nome da instância do processo

Xrm.Page.data.process.getInstanceName();
  • Valor de Retorno
    Digite:String

getStatus

Retorna o status atual da instância do processo

Xrm.Page.data.process.getStatus();

  • Valor de Retorno
    Digite:String

    Comentários: esse método retornará um dos seguintes valores: active, aborted ou finished.

setStatus

Define o status atual da instância do processo ativa.

Xrm.Page.data.process.setStatus(status, callbackFunction);

Parâmetros:

  • status
    Digite:String

    Comentários: os valores podem ser active, aborted ou finished.

  • callbackFunction
    Digite:Function

    Comentários: Uma função opcional para chamar quando a operação for concluída. Essa função de retorno de chamada tem o novo status passado como um valor de cadeia de caracteres.

Métodos do estágio

Um estágio contém os dados para um estágio em um fluxo de processos empresarial. Use os métodos para acessar propriedades do estágio.

getCategory

Retorna um objeto com um método getValue que retornará o valor inteiro da categoria do fluxo do processo empresarial.

var stageCategoryNumber = stageObj.getCategory().getValue();

  • Valor de Retorno
    Tipo:Number

    Comentários: Consulte afe17a4a-fdca-44b4-8c14-a19ba327662e#BKMK_StageCategory para a lista de possíveis valores.

getEntityName

Retorna o nome lógico da entidade associada ao estágio.

var stageEntityName = stageObj.getEntityName();
  • Valor de Retorno
    Tipo:String

getId

Retorna o identificador exclusivo do estágio

var stageId = stageObj.getId();
  • Valor de Retorno
    Tipo:String

getName

Retorna o nome do estágio

var stageName = stageObj.getName();
  • Valor de Retorno
    Tipo:String

getStatus

Retorna o status do estágio

var stageStatus = stageObj.getStatus();

  • Valor de Retorno
    Tipo:String

    Comentários: Este método retornará active ou inactive.

getSteps

Retorna um conjunto de etapas no estágios.

var stepsCollection = stageObj.getSteps();

  • Valor de Retorno
    Tipo:Array

    Consulte Métodos da etapa para os métodos para acessar os valores de propriedade da etapa.

Métodos da etapa

Uma etapa contém os dados para uma etapa em um estágio em um fluxo de processos empresarial. Use os métodos para acessar propriedades da etapa.

getAttribute

Retorna o nome lógico do atributo associado à etapa.

var stepAttributeName = stepObj.getAttribute();

  • Valor de Retorno
    Tipo:String

    Comentários: Algumas etapas não contém um valor de atributo.

getName

Retorna o nome da etapa.

var stepName = stepObj.getName();
  • Valor de Retorno
    Tipo:String

isRequired

Retorna se a etapa é necessária no fluxo de processos empresarial.

var stepIsRequired = stepObj.isRequired();

  • Valor de Retorno
    Tipo:Boolean

    Comentários: Retorna true se a etapa for marcada como obrigatória no editor do Fluxo de Processo Empresarial; caso contrário, false. Não há nenhuma conexão entre esse valor e os valores que você pode alterar nos métodos 6881e99b-45e4-4552-8355-2eef296f2cd8#BKMK_RequiredLevel atributo Xrm.Page.data.entity.

Confira Também

Criar scripts para fluxos de processos de negócios
Xrm.Page.ui.process (referência do cliente)
Referência de programação do cliente
Referência rápida do script de formulário
Crie códigos para os formulários do Microsoft Dynamics 365
Use o modelo de objeto Xrm.Page
Exemplo: Xrm.Page.data.process.getEnabledProcesses
Exemplo: Xrm.Page.data.process.getActivePath

Microsoft Dynamics 365

© 2017 Microsoft. Todos os direitos reservados. Direitos autorais