Configuração OData do Microsoft Dynamics microsoft-dynamics-odata-configuration
Aplica-se a applies-to
Esta documentação se aplica ao AEM 6.5 LTS Forms.
Para obter a documentação do AEM as a Cloud Service, consulte AEM Forms no Cloud Service.
A Microsoft Dynamics é um software de CRM (Customer Relationship Management, gerenciamento de relacionamento com o cliente) e ERP (Enterprise Resource Planning, planejamento de recursos corporativos) que fornece soluções corporativas para criar e gerenciar contas, contatos, clientes potenciais, oportunidades e casos de clientes. A Integração de Dados do AEM Forms fornece uma configuração do serviço de nuvem OData para integrar o Forms ao servidor do Microsoft Dynamics local e online. Ela permite criar um modelo de dados de formulário com base nas entidades, atributos e serviços definidos no serviço Microsoft Dynamics. O modelo de dados de formulário pode ser usado para criar formulários adaptáveis que interagem com o servidor do Microsoft Dynamics para habilitar workflows de negócios. Por exemplo:
- Consultar o servidor Microsoft Dynamics para obter dados e preencher formulários adaptáveis
- Gravar dados no Microsoft Dynamics no envio de formulários adaptáveis
- Gravar dados no Microsoft Dynamics por meio de entidades personalizadas definidas no modelo de dados de formulário e vice-versa
O pacote complementar do AEM Forms também inclui a configuração OData de referência que você pode usar para integrar rapidamente o Microsoft Dynamics ao AEM Forms.
Quando o pacote é instalado, as seguintes entidades e serviços estão disponíveis na instância do AEM Forms:
- CLOUD SERVICE OData do MS Dynamics (Serviço OData)
- Modelo de dados de formulário com entidades e serviços pré-configurados do Microsoft Dynamics.
Entidades e serviços pré-configurados do Microsoft Dynamics em um modelo de dados de formulário estarão disponíveis na sua instância do AEM Forms somente se o modo de execução da instância do AEM estiver definido como samplecontent (padrão). O MS Dynamics OData Cloud Service (Serviço OData) também está disponível com outros modos de execução. Para obter mais informações sobre como configurar os modos de execução para uma instância do AEM, consulte Modos de Execução.
Pré-requisitos prerequisites
Antes de começar a instalar e configurar o Microsoft Dynamics, verifique se você tem:
-
Instalado o pacote complementar do AEM Forms
-
O Microsoft Dynamics 365 foi configurado online ou instalou uma instância de uma das seguintes versões do Microsoft Dynamics:
- Microsoft Dynamics 365 no local
- Microsoft Dynamics 2016 no local
-
Aplicativo registrado para o serviço online do Microsoft Dynamics com o Ative Diretory do Microsoft Azure. Anote os valores da ID do cliente (também chamada de ID do aplicativo) e o segredo do cliente para o serviço registrado. Esses valores são usados ao configurar o serviço em nuvem para seu serviço Microsoft Dynamics.
Definir URL de resposta para o aplicativo Microsoft Dynamics registrado set-reply-url-for-registered-microsoft-dynamics-application
Faça o seguinte para definir o URL de resposta para o aplicativo Microsoft Dynamics registrado:
-
Vá para a conta do Ative Diretory do Microsoft Azure e adicione a seguinte URL de configuração do serviço de nuvem nas configurações de URLs de resposta para seu aplicativo registrado:
https://'[server]:[port]'/libs/fd/fdm/gui/components/admin/fdmcloudservice/createcloudconfigwizard/cloudservices.html
-
Salve a configuração.
Configurar Microsoft Dynamics para IFD configure-microsoft-dynamics-for-ifd
O Microsoft Dynamics usa autenticação baseada em declarações para fornecer acesso aos dados no servidor do Microsoft Dynamics CRM para usuários externos. Para habilitar isso, faça o seguinte para configurar o Microsoft Dynamics para IFD (implantação na Internet) e definir as configurações de declaração.
-
Configure a instância local do Microsoft Dynamics para IFD conforme descrito em Configurar IFD para Microsoft Dynamics.
-
Execute os seguintes comandos usando o Windows PowerShell para definir configurações de declaração no Microsoft Dynamics habilitado para IFD:
code language-shell Add-PSSnapin Microsoft.Crm.PowerShell $ClaimsSettings = Get-CrmSetting -SettingType OAuthClaimsSettings $ClaimsSettings.Enabled = $true Set-CrmSetting -Setting $ClaimsSettingsConsulte Registro de aplicativo para CRM local (IFD) para obter detalhes.
Configurar o cliente OAuth no computador do AD FS configure-oauth-client-on-ad-fs-machine
Faça o seguinte para registrar um cliente OAuth em um computador do Ative Diretory Federation Services (AD FS) e conceder acesso a esse computador:
-
Execute o seguinte comando:
Add-AdfsClient -ClientId "<Client-ID>" -Name "<name>" -RedirectUri "<redirect-uri>" -GenerateClientSecretEm que:
Client-IDé uma ID de cliente que você pode gerar usando qualquer gerador de GUID.redirect-urié a URL para o serviço de nuvem OData do Microsoft Dynamics no AEM Forms. O serviço de nuvem padrão instalado com o pacote do AEM Forms é implantado no seguinte URL:https://'[server]:[port]'/libs/fd/fdm/gui/components/admin/fdmcloudservice/createcloudconfigwizard/cloudservices.html
-
Execute o seguinte comando para conceder acesso à máquina do AD FS:
Grant-AdfsApplicationPermission -ClientRoleIdentifier "<Client-ID>" -ServerRoleIdentifier <resource> -ScopeNames openidEm que:
resourceé a URL da organização da Microsoft Dynamics.
-
O Microsoft Dynamics usa o protocolo HTTPS. Para invocar pontos de extremidade do AD FS do servidor do Forms, instale o certificado do site do Microsoft Dynamics no armazenamento de certificados Java usando o comando
keytoolno computador que executa o AEM Forms.
Configurar o serviço em nuvem para o serviço Microsoft Dynamics configure-cloud-service-for-your-microsoft-dynamics-service
A configuração MS Dynamics OData Cloud Service (OData Service) vem com a configuração OData padrão. Para configurá-lo para se conectar com o serviço Microsoft Dynamics, faça o seguinte.
-
Navegue até Ferramentas > Cloud Services > Fontes de Dados e selecione a pasta de configuração
global. -
Selecione a configuração MS Dynamics OData Cloud Service (OData Service) e selecione Propriedades. A caixa de diálogo de propriedade de configuração do Cloud Service é aberta.
Na guia Configurações de autenticação:
-
Insira o valor para o campo Raiz de Serviço. Vá para a instância do Dynamics e navegue até Recursos do Desenvolvedor para exibir o valor do campo Raiz do Serviço. Por exemplo, https://<tenant-name>/api/data/v9.1/
-
Substitua os valores padrão nos campos ID do Cliente(também conhecido como ID do Aplicativo), Segredo do Cliente, URL do OAuth, URL do Token de Atualização, URL do Token de Acesso e URL por valores da configuração do serviço Microsoft Dynamics. É obrigatório especificar a URL da instância do Dynamics no campo Resource para configurar o Microsoft Dynamics com um modelo de dados de formulário. Use o URL raiz do serviço para derivar o URL da instância dinâmica. Por exemplo, https://org.crm.dynamics.com.
-
Especifique openid no campo Escopo de Autorização para o processo de autorização no Microsoft Dynamics.
-
-
Clique em Conectar ao OAuth. Você é redirecionado para a página de logon do Microsoft Dynamics.
-
Faça logon com as credenciais da Microsoft Dynamics e aceite para permitir que a configuração do serviço de nuvem se conecte ao serviço da Microsoft Dynamics. É uma tarefa única para estabelecer a conexão entre o serviço de nuvem e o serviço.
Em seguida, você será redirecionado para a página de configuração do Cloud Service, que exibirá uma mensagem informando que a configuração OData foi salva com êxito.
O serviço de nuvem MS Dynamics OData Cloud Service (OData Service) está configurado e conectado ao serviço Dynamics.
Criar modelo de dados de formulário create-form-data-model
Quando você instala o pacote do AEM Forms, um modelo de dados de formulário,Microsoft Dynamics FDM, é implantado em sua instância do AEM. Por padrão, o modelo de dados de formulário usa o serviço Microsoft Dynamics configurado no MS Dynamics OData Cloud Service (OData Service) como a fonte de dados.
Ao abrir o modelo de dados de formulário pela primeira vez, ele se conecta ao serviço Microsoft Dynamics configurado e busca entidades da sua instância do Microsoft Dynamics. As entidades "contact" e "lead" da Microsoft Dynamics já estão adicionadas no modelo de dados de formulário.
Para revisar o modelo de dados do formulário, acesse Forms > Integrações de dados. Selecione o Microsoft Dynamics FDM e clique em Editar para abrir o modelo de dados de formulário no modo de edição. Como alternativa, você pode abrir o modelo de dados de formulário diretamente da seguinte URL:
https://'[server]:[port]'/aem/fdm/editor.html/content/dam/formsanddocuments-fdm/ms-dynamics-fdm
Em seguida, você pode criar um formulário adaptável com base no modelo de dados de formulário e usá-lo em vários casos de uso de formulário adaptável, como:
- Preencha previamente o formulário adaptável consultando informações de entidades e serviços da Microsoft Dynamics
- Invocar operações do servidor do Microsoft Dynamics definidas em um modelo de dados de formulário usando regras de formulário adaptáveis
- Gravar dados de formulário enviados em entidades do Microsoft Dynamics
É recomendável criar uma cópia do modelo de dados de formulário fornecido com o pacote do AEM Forms e configurar modelos de dados e serviços para atender aos seus requisitos. Ele garantirá que qualquer atualização futura do pacote não substitua o modelo de dados de formulário.
Para obter mais informações sobre como criar e usar o modelo de dados de formulário em fluxos de trabalho de negócios, consulte Integração de Dados.