Microsoft Dynamics Application Scope

UiPath.MicrosoftDynamics.Activities.MicrosoftDynamicsScopeActivity

As atividades do Dynamics 365 usam o OAuth com o protocolo Common Data Service para estabelecer uma conexão autenticada entre o UiPath e seu aplicativo Dynamics 365. Essa conexão autoriza um Robô a chamar as APIs da Web e acessar recursos em seu nome.

Para habilitar a autenticação, você usa o Azure Active Directory (AAD) para registrar seu aplicativo do Dynamics 365 no tenant da sua conta. O registro do aplicativo gera um ID do aplicativo (cliente) , que é usado, juntamente com outros identificadores, para estabelecer um acesso autenticado à sua instância. Para obter mais informações e antes de criar seu primeiro projeto de automação, consulte o Guia de configuração .

Depois de concluir o registro do aplicativo, selecione o tipo de autenticação que deseja usar (AuthenticationType) e insira a ID do aplicativo (cliente) (ClientId), ponto de extremidade do aplicativo Dynamics 365 (EndpointUrl), ID do diretório (locatário) (TenantId) e dependendo do tipo de autenticação que você selecionar, o segredo do cliente (ClientSecret).

Como funciona

As etapas a seguir e o diagrama de sequência de mensagens são um exemplo de como a atividade funciona desde o tempo de design (ou seja, as dependências da atividade e as propriedades de entrada/saída) até o tempo de execução.

1. Conclua as etapas de Configuração .

2. Adicione uma atividade se seu TipoDeAutenticação for CredenciaisDoCliente. Caso contrário, será N/A.

   • Para obter mais informações, consulte Gerenciamento de credenciais neste guia.
3. Adicione a atividade Escopo do aplicativo do Microsoft Dynamics ao seu projeto.
4. Insira valores para as propriedades de entrada de Conexão .
5. Crie e insira uma variável MicrosoftDynamicsConnection para propriedade de saída .

   • Você pode usar essa variável em usos subsequentes da atividade Escopo do aplicativo do Microsoft Dynamics .

     
     

     

     
     

No corpo da atividade

Para construir seu projeto e habilitar o Object Wizard em outras atividades, você deve utilizar o Connection Wizard clicando no botão Configurar .

Para saber mais sobre o Assistente de Conexão, consulte a página Estruturas de atividades de negócios .

Nota: Configurar os campos no Assistente de Conexão não preenche as propriedades do Escopo do Aplicativo do Microsoft Dynamics . O assistente estabelece uma conexão com seu aplicativo Microsoft Dynamics 365 somente durante o tempo de design; habilitar os Assistentes de Objetos nas outras atividades do Microsoft Dynamics 365.

Propriedades

Comum

• NomeDeExibição — o nome de exibição da atividade. Este campo é compatível apenas com variáveis Strings ou String.

Conexão

• AuthenticationType - O tipo de autenticação que você deseja usar para se conectar ao seu aplicativo Dynamics 365. Selecione um item na lista suspensa. Existem duas opções:

  • PasswordCredentials - Se selecionada, a autenticação é feita por meio de um prompt do usuário (de acordo com a opção selecionada na propriedade Prompt ) para inserir a senha da conta do Dynamics 365. Esta opção é apenas para automação assistida.
  • CredenciaisDoCliente - Se estiver selecionada, a autenticação é feita por meio de um SegredoDoCliente. Esta opção é compatível tanto com automação assistida quanto não assistida. Para obter mais informações sobre as credenciais do cliente, consulte Usar segredos e certificados do cliente na documentação da Microsoft.
• ClientId - O ID do aplicativo (cliente) gerado automaticamente atribuído ao seu aplicativo registrado. Este campo suporta apenas String variáveis.
  • O IdDoCliente é gerado quando você registra seu aplicativo usando o Azure Active Directory (AAD). Para obter mais informações, consulte a seção Registrar seu aplicativo do Guia de configuração .
  • Se seu valor de TipoDeAutenticação for CredenciaisDoCliente, o IdDoCliente será associado a SegredoDoCliente. Devido a esse relacionamento, é recomendável que você crie uma variável String para essa propriedade seguindo a seção Criar ativo de credencial do Guia de configuração .
  • Para criar e inserir sua variável String para essa propriedade, use uma atividade para gerar seu Ativo de credenciais (consulte o exemplo abaixo).
• ClientSecret - A senha (associada ao nome de usuário) para sua instância do ServiceNow. Insira uma variável SecureString .
  • O SegredoDoCliente pode ser gerado quando você registra seu aplicativo usando o Azure Active Directory (AAD). Para obter mais informações, consulte a seção Criar segredo do cliente do Guia de configuração .
  • Para criar uma variável SecureString , consulte a seção Criar ativo de credencial do Guia de configuração .
  • Para inserir sua variável SecureString , use uma atividade que gere seu Ativo de Credencial (consulte o exemplo abaixo).
• EndpointUrl - A URL da instância do CRM à qual você deseja se conectar. Este campo suporta apenas variáveis Strings ou String .

• Prompt - especifica o comportamento do prompt de senha para a autenticação PasswordCredentials . Selecione um item na lista suspensa. Existem três opções:

  • Auto - O prompt só aparece quando as credenciais são necessárias.
  • SelectAccount - O prompt exige que um usuário selecione uma conta e insira suas credenciais (usadas quando há várias contas).
  • Sempre - O prompt aparece sempre que a atividade é executada (mesmo quando há um token no cache).
• TenantId - a ID do diretório (locatário) atribuída ao seu locatário do Azure Active Directory (ADD). Este campo suporta apenas variáveis Strings ou String .

Conexão Existente

• ExistingMicrosoftDynamicsConnection - Um registro de conexão de uma atividade pai do Escopo do aplicativo do Microsoft Dynamics que você pode usar em vez de estabelecer uma nova conexão. Insira uma variável MicrosoftDynamicsConnection .
  • A variável MicrosoftDynamicsConnection deve ser de uma atividade do Microsoft Dynamics Application Scope executada anteriormente (pai) que ainda tenha uma conexão ativa.
  • Se você não conseguir estabelecer uma conexão usando esta propriedade, tente executar novamente sua atividade pai do Escopo do aplicativo do Microsoft Dynamics .

Diversos

• Privado - Se selecionado, os valores de variáveis e argumentos não são mais registrados no nível Verbose.

Opções

• ReportApiErrorAsException - Quando selecionado, as respostas de erro da API são relatadas em BusinessActivityExecutionException por todas as atividades filhas que usam esse escopo de aplicativo. Quando desmarcada, a atividade filho preenche a mensagem de erro da API na propriedade de saída ResponseStatus e a execução do fluxo de trabalho continua. Verifique a propriedade ResponseStatus para confirmar a execução bem-sucedida.

Saída

• ConexãoComOMicrosoftDynamics - Um registro da sua conexão estabelecida que você pode usar em outras atividades do Microsoft Dynamics Application Scope que estão incluídas nessa atividade de escopo. Insira uma variável MicrosoftDynamicsConnection . Você pode passar essa variável para uma atividade de escopo em um fluxo de trabalho que esteja dentro da atividade de escopo pai.
  • Por exemplo, você pode ter 3 fluxos de trabalho. A primeira inclui a atividade do escopo pai que estabelece a conexão com seu aplicativo registrado (ou seja, fluxo de trabalho pai). O segundo fluxo de trabalho cria um novo registro de contato e o terceiro cria um novo registro de conta; ambos estão incluídos na atividade do escopo pai.
  • Quando os fluxos de trabalho são executados, a atividade do escopo pai passa a variávelMicrosoftDynamicsConnection para a propriedade ExistingMicrosoftDynamicsConnection no segundo e terceiro fluxos de trabalho (consulte a imagem abaixo).
    
    

    

    
    

Exemplo

A imagem a seguir mostra um exemplo do relacionamento de dependência de atividade e valores de propriedade de entrada/saída.