Dynamics 365 Business Central

O conector do Dynamics 365 Business Central permite executar operações de inserção, exclusão, atualização e leitura nos dados do Dynamics 365 Business Central.

Versões compatíveis

Esse conector é compatível com as seguintes versões:

  • Dynamics 365 Business Central Cloud, versão do ambiente de produção: 24.5.23489.26544
  • Dynamics 365 Business Central, versão local: Dynamics.365.BC.25445.IN.DVD
  • Antes de começar

    Antes de usar o conector do Dynamics 365, faça o seguinte:

    • No seu projeto do Google Cloud, faça o seguinte:
      • Verifique se a conectividade de rede está configurada. Para informações sobre padrões de rede, consulte Conectividade de rede.
      • Ative os seguintes serviços:
        • secretmanager.googleapis.com (API Secret Manager)
        • connectors.googleapis.com (API Connectors)

        Para entender como ativar os serviços, consulte Como ativar serviços.

      Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

    Configurar o conector

    Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, faça o seguinte:

    1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

      Acessar a página "Conexões"

    2. Clique em + Criar novo para abrir a página Criar conexão.
    3. Na seção Local, escolha o local da conexão.
      1. Região: selecione um local na lista suspensa.

        Veja abaixo as regiões compatíveis com o conector:

        Para conferir a lista de todas as regiões com suporte, consulte Locais.

      2. Clique em Próxima.
    4. Na seção Detalhes da conexão, faça o seguinte:
      1. Conector: selecione Dynamics 365 Business Central na lista suspensa de conectores disponíveis.
      2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
      3. No campo Nome da conexão, insira um nome para a instância de conexão

        Os nomes de conexão precisam atender aos seguintes critérios:

        • Os nomes de conexões podem usar letras, números ou hifens.
        • As letras precisam ser minúsculas.
        • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
        • Os nomes das conexões não podem ter mais de 49 caracteres.
      4. Como opção, insira uma Descrição para a instância de conexão.
      5. Como opção, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
      6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
      7. (Opcional) Defina as Configurações do nó de conexão.
        • Número mínimo de nós: digite o número mínimo de nós de conexão.
        • Número máximo de nós: digite o número máximo de nós de conexão.

        Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir nenhum valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

      8. Locatário do Azure: especifique o locatário do Microsoft Online usado para acessar dados. Se não for especificado, seu locatário padrão será usado.
      9. Empresa: especifique o nome da empresa que você configurou no Dynamics 365. Essas informações estão na página Informações da empresa no Dynamics 365 Business Central.
      10. Tipo de endpoint: especifique o tipo de endpoint para o qual a OrganizationUrl precisa ser resolvida.
      11. Incluir propriedades de navegação: especifique se a lista de colunas precisa incluir propriedades de navegação. As propriedades de navegação oferecem uma maneira de navegar por uma associação entre dois tipos de entidade.
      12. Usar sandbox: especifica se um sandbox é usado.
      13. Visualizações definidas pelo usuário: especifique um caminho para um arquivo de configuração JSON que define visualizações personalizadas.
      14. Clique em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
      15. (Opcional) Se quiser usar o SSL, selecione Ativar SSL. Os detalhes da configuração do SSL serão exibidos.
        1. Selecione um tipo de loja de confiança. Pode ser Pública, Particular ou Conexão não segura.
        2. Selecione os certificados com base na sua seleção de loja de confiança.
        3. Se você estiver usando mTLS, selecione os certificados de armazenamento de chaves na seção Armazenamento de chaves.
      16. Clique em Próxima.
    5. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      A conexão do Dynamics 365 Business Central oferece suporte aos seguintes tipos de autenticação:

      • Chave de acesso
      • Credenciais do cliente OAuth 2.0
      • Azure AD
    6. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

    7. Clique em Next.
  • Revisão: revise os detalhes de conexão e autenticação.
  • Clique em Criar.
  • Configurar a autenticação

    Digite os detalhes com base na autenticação que você quer usar.

    • Chave de acesso
      • Nome de usuário: especifique o nome de usuário da conta do Dynamics 365 on-premises usada para autenticação no servidor do Microsoft Dynamics 365 Business Central.
      • Senha:selecione o segredo que contém a senha da conta do Dynamics 365 on-premises.
      • Versão do secret: selecione a versão do secret.
      • Chave de acesso: especifique a chave de acesso usada para autenticação no Microsoft Dynamics 365 Business Central.
    • Credenciais do cliente OAuth 2.0
      • ID do cliente: especifique o ID do cliente do app que você criou.
      • Chave secreta do cliente: especifique o secret do Secret Manager que contém a chave secreta do cliente para o app conectado que você criou.
      • Versão do secret: a versão do chave secreta do cliente.
  • Azure AD
    • ID do cliente: especifique o ID do cliente usado para solicitar tokens de acesso. Essa informação está na visão geral do app conectado criado no portal do Azure.
    • Escopo:especifique uma lista separada por vírgulas dos escopos desejados.
    • Chave secreta do cliente: especifique o secret do Secret Manager que contém a chave de acesso à conta.
    • URL de autorização: insira o URL de autorização gerado ao criar um cliente OAuth. Insira o URL no seguinte formato: https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent. Por exemplo, https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize?prompt=consent.
  • Exemplos de configuração de conexão

    Esta seção lista os valores de exemplo para os vários campos que você configura ao criar a conexão.

    OAuth 2.0: tipo de conexão de credenciais do cliente

    Nome do campo Detalhes
    Local europe-west1
    Conector Dynamics365BusinessCentral
    Versão do conector 1
    Nome da conexão dynamics-businesscentral-conn
    Ativar Cloud Logging Sim
    Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
    Azure Tenant c9f472d9-7d8a-44cf-8ee0-458d32e26bce
    Empresa Organization_Name
    Número mínimo de nós 2
    Número máximo de nós 50
    URL da organização https://api.businesscentral.dynamics.com/v2.0/c9f472d9-7d8a-44cf-8ee0-458d32e26bce/production/api/v2.0
    Autenticação Credenciais do cliente OAuth 2.0
    ID do cliente fd04bae4-c30c-4faf-bbae-9263d4d96d61
    Chave secreta do cliente projects/617888503870/secrets/businesscentral-client-secret
    Versão do secret 1

    Tipo de conexão da chave de acesso

    Nome do campo Detalhes
    Local europe-west1
    Conector Dynamics365BusinessCentral
    Versão do conector 1
    Nome da conexão dynamics-businesscentral-on-prem-conn
    Ativar Cloud Logging Sim
    Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
    Azure Tenant BC250
    Empresa Altostart Ltd.
    Número mínimo de nós 2
    Número máximo de nós 50
    URL da organização http://10.128.0.78:7059/BC250/ODataV4
    Autenticação Chave de acesso
    Nome de usuário businesscentral
    Senha SENHA
    Versão do secret 1
    Chave de acesso OQq9qggeWxt9iZPSWrs8wgfNjsAq06PT2uls7Luhbp8=
    Versão do secret 1

    Para saber como criar um espaço de trabalho do Dynamics 365 Business Central, consulte Bem-vindo ao Dynamics 365 Business Central.

    Para informações sobre a API Dynamics 365 Business Central, consulte a referência da API Dynamics365BusinessCentral.

    Limitações do sistema

    O conector do Dynamics 365 Business Central pode processar no máximo 25 transações por segundo, por , e limita as transações além desse limite. Por padrão, os Integration Connectors alocam dois nós (para melhor disponibilidade) para uma conexão.

    Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

    Usar a conexão do Dynamics 365 Business Central em uma integração

    Depois de criar a conexão, ela fica disponível na integração da Apigee e Application Integration. É possível usar a conexão em uma integração pela tarefa de conectores.

    • Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
    • Para entender como criar e usar a tarefa "Conectores" na Application Integration, consulte Tarefa "Conectores".

    Exemplos de operações de entidade

    Esta seção mostra como realizar algumas das operações de entidade neste conector.

    Exemplo: listar todos os pedidos de venda

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione salesOrders na lista Entity.
    3. Selecione a operação List e clique em Concluído.
    4. Na seção Entrada de tarefa da tarefa Conectores, é possível definir a filterClause.
    5. Use aspas simples (") para incluir o valor de uma cláusula de filtro. É possível usar a cláusula de filtro para filtrar registros com base nas colunas.

    Exemplo: receber um pedido de venda

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione salesOrders na lista Entity.
    3. Selecione a operação Get e clique em Concluído.
    4. Defina o ID da entidade como "841c04f9-3391-ef11-8a6b-002248d4e29e", que é a chave a ser transmitida. Para definir o ID da entidade, na seção Data Mapper do Mapeamento de dados, clique em Abrir editor de mapeamento de dados e insira "841c04f9-3391-ef11-8a6b-002248d4e29e" no campo Valor de entrada e escolha EntityId como a variável local.

      O valor do ID da entidade precisa ser transmitido diretamente, como "841c04f9-3391-ef11-8a6b-002248d4e29e". Aqui, "841c04f9-3391-ef11-8a6b-002248d4e29e" é o valor da chave primária exclusiva.

      Se a transmissão de um único ID de entidade gerar um erro devido à presença de duas chaves compostas, use a cláusula de filtro para transmitir o valor.

    Exemplo: excluir um pedido de venda

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione salesOrders na lista Entity.
    3. Selecione a operação DELETE e clique em Concluído.
    4. Defina o ID da entidade como "841c04f9-3391-ef11-8a6b-002248d4e29e", que é a chave a ser transmitida. Para definir o ID da entidade, na seção Data Mapper do Mapeamento de dados, clique em Abrir editor de mapeamento de dados e insira "841c04f9-3391-ef11-8a6b-002248d4e29e" no campo Valor de entrada e escolha EntityId como a variável local.

      Se a entidade tiver duas chaves primárias ou de negócios compostas em vez de especificar o entityId, também será possível definir a filterClause como id='841c04f9-3391-ef11-8a6b-002248d4e29e'.

    Exemplo: criar um pedido de venda

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione salesOrders na lista Entity.
    3. Selecione a operação Create e clique em Concluído.
    4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como a variável local.
      {
           "orderDate": "2024-10-30",
           "customerNumber": "10000",
           "currencyCode": "INR",
           "paymentTermsId": "590d75c5-f26e-ef11-a678-6045bdc89b07"
           }
           

      Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa salesOrders vai ter um valor semelhante a este:

      {
           "id": "2e048d8a-a796-ef11-8a6b-6045bdae882d"
           }
           

    Exemplo: criar uma linha de pedido de venda

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione salesOrderLines na lista Entity.
    3. Selecione a operação Create e clique em Concluído.
    4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como a variável local.
      {
           "documentId": "b747cc93-c37f-ef11-ac23-7c1e523b4365",
           "sequence": 10014,
           "itemId": "8b0f75c5-f26e-ef11-a678-6045bdc89b07",
           "lineType": "Item",
           "lineObjectNumber": "1996-S"
           }
           

      Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa salesOrderLines terá um valor semelhante a este:

      {
           "id": "35535130-d09d-ef11-8a6b-002248d4cc93"
           }
           

    Exemplo: criar um orçamento de vendas

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione salesQuotes na lista Entity.
    3. Selecione a operação Create e clique em Concluído.
    4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como a variável local.
      {
           "paymentTermsId": "590d75c5-f26e-ef11-a678-6045bdc89b07",
           "currencyCode": "INR",
           "customerNumber": "30000"
           }
           

      Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa salesQuotes terá um valor semelhante a este:

      {
           "id": "2116bd4e-3ba3-ef11-8a6b-6045bdacfb5e"
           }
           

    Exemplo: criar uma ordem de compra

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione purchaseOrders na lista Entity.
    3. Selecione a operação Create e clique em Concluído.
    4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como a variável local.
      {
           "vendorId": "7e0f75c5-f26e-ef11-a678-6045bdc89b07",
           "vendorNumber": "10000"
           }
           

      Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa purchaseOrders terá um valor semelhante a este:

      {
           "id": "53389ee7-a796-ef11-8a6b-6045bdae882d"
           }
           

    Exemplo: criar um item

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione items na lista Entity.
    3. Selecione a operação Create e clique em Concluído.
    4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como a variável local.
      {
           "number": "4000-D",
           "displayName": "Charlie Altostrat",
           "type": "Inventory",
           "itemCategoryId": "d61672cb-f26e-ef11-a678-6045bdc89b07",
           "baseUnitOfMeasureCode": "PCS"
           }
           

      Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa items terá um valor semelhante a este:

      {
           "id": "fad09437-8d9e-ef11-8a6b-000d3af0e092"
           }
           

    Exemplo: atualizar um pedido de venda

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione salesOrders na lista Entity.
    3. Selecione a operação Update e clique em Concluído.
    4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como a variável local.
      {
           "phoneNumber": "7764872993"
           }
           
    5. Defina o ID da entidade no Data Mapper como a entidade das vendas. Para definir o ID da entidade, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como a variável local.

      Em vez de especificar o entityId, você também pode definir a filterClause como id ='5e9226d3-1c7b-ef11-a671-6045bdaef76c'.

    Exemplo: atualizar uma linha de pedido de venda

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione salesOrderLines na lista Entity.
    3. Selecione a operação Update e clique em Concluído.
    4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como a variável local.
      {
           "description": "Test from Altostrat"
           }
           
    5. Defina o ID da entidade no Data Mapper como a entidade das salesOrderLines. Para definir o ID da entidade, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como a variável local.

      Em vez de especificar o entityId, você também pode definir a filterClause como id ='35535130-d09d-ef11-8a6b-002248d4cc93'.

    Exemplo: atualizar uma cotação de vendas

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione salesQuotes na lista Entity.
    3. Selecione a operação Update e clique em Concluído.
    4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como a variável local.
      {
           "currencyCode": "USD"
           }
           
    5. Defina o ID da entidade no Data Mapper como a entidade das vendas de cotações. Para definir o ID da entidade, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como a variável local.

      Em vez de especificar o entityId, você também pode definir a filterClause como id='2116bd4e-3ba3-ef11-8a6b-6045bdacfb5e'.

    Exemplo: atualizar uma ordem de compra

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione purchaseOrders na lista Entity.
    3. Selecione a operação Update e clique em Concluído.
    4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como a variável local.
      {
           "shipToName": "Charlie Cruz"
           }
           
    5. Defina o ID da entidade no Data Mapper como a entidade das purchaseOrders. Para definir o ID da entidade, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como a variável local.

      Em vez de especificar o entityId, você também pode definir a filterClause como id ='6b88738e-3891-ef11-8a6b-002248d4e29e'.

    Exemplo: atualizar um item

    1. Na caixa de diálogo Configure connector task, clique em Entities.
    2. Selecione items na lista Entity.
    3. Selecione a operação Update e clique em Concluído.
    4. Na seção Data Mapper da tarefa Data Mapping, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como a variável local.
      {
           "displayName": "Updates Altostrat name"
           }
           
    5. Defina o ID da entidade no Data Mapper como a entidade dos itens. Para definir o ID da entidade, clique em Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como a variável local.

      Em vez de especificar o entityId, você também pode definir a filterClause como id ='fad09437-8d9e-ef11-8a6b-000d3af0e092'.

    Receber ajuda da comunidade do Google Cloud

    Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

    A seguir