Dynamics 365 Business Central

O conector do Dynamics 365 Business Central permite-lhe realizar operações de inserção, eliminação, atualização e leitura nos dados do Dynamics 365 Business Central.

Versões suportadas

Este conector suporta 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 no local - Dynamics.365.BC.25445.IN.DVD

    • Antes de começar

    Antes de usar o conector do Dynamics365, conclua as seguintes tarefas:

    • No seu projeto do Google Cloud:
      • Certifique-se de que a conetividade de rede está configurada. Para obter informações sobre padrões de rede, consulte o artigo Conetividade de rede.
      • Ative os seguintes serviços:
        • secretmanager.googleapis.com (Secret Manager API)
        • connectors.googleapis.com (API Connectors)

        Para saber como ativar serviços, consulte o artigo Ativar serviços.

      Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

    Configure o conetor

    Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

    1. Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.

      Aceda à página Ligações

    2. Clique em + Criar novo para abrir a página Criar associação.
    3. Na secção Localização, escolha a localização para a ligação.
      1. Região: selecione uma localização na lista pendente.

        As regiões suportadas para conetores incluem:

        Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.

      2. Clicar em Seguinte.
    4. Na secção Detalhes da associação, conclua o seguinte:
      1. Conector: selecione Dynamics 365 Business Central na lista pendente de conectores disponíveis.
      2. Versão do conetor: selecione a versão do conetor na lista pendente de versões disponíveis.
      3. No campo Nome da ligação, introduza um nome para a instância de ligação.

        Os nomes das associações têm de cumprir os seguintes critérios:

        • Os nomes das associações podem usar letras, números ou hífenes.
        • As letras têm de ser minúsculas.
        • Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
        • Os nomes das associações não podem exceder 49 carateres.
      4. Opcionalmente, introduza uma Descrição para a instância de associação.
      5. Opcionalmente, ative o Registo na nuvem e, em seguida, selecione um nível de registo. Por predefinição, o nível do registo está definido como Error.
      6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
      7. (Opcional) Configure as definições do nó de associação.
        • Número mínimo de nós: introduza o número mínimo de nós de ligação.
        • Número máximo de nós: introduza o número máximo de nós de ligação.

        Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.
      8. Inquilino do Azure: especifique o inquilino online da Microsoft que está a ser usado para aceder aos dados. Se não for especificado, é usado o seu inquilino predefinido.
      9. Empresa: especifique o nome da empresa que configurou no Dynamics 365. Pode encontrar estas informações na página Informações da empresa no Dynamics 365 Business Central.
      10. Tipo de ponto final: especifique o tipo de ponto final para o qual o OrganizationUrl tem de ser resolvido.
      11. Include Navigation Properties (Incluir propriedades de navegação): especifique se a lista de colunas tem de incluir propriedades de navegação. As propriedades de navegação oferecem uma forma de navegar numa associação entre dois tipos de entidades.
      12. Usar sandbox: especifique se é usada uma sandbox.
      13. Vistas definidas pelo utilizador: especifique um caminho de ficheiro para um ficheiro de configuração JSON que defina vistas personalizadas.
      14. Clique em + Adicionar etiqueta para adicionar uma etiqueta à associação sob a forma de um par de chave/valor.
      15. (Opcional) Se quiser usar SSL, selecione Ativar SSL. São apresentados os detalhes da configuração SSL.
        1. Selecione um tipo de loja fidedigna. Pode ser Público, Privado ou Ligação não segura.
        2. Selecione os certificados conforme apresentado com base na sua seleção da loja de confiança.
        3. Se estiver a usar o mTLS, selecione os certificados do armazenamento de chaves na secção Armazenamento de chaves.
      16. Clicar em Seguinte.
    5. Selecione um Tipo de autenticação e introduza os detalhes relevantes.

      Os seguintes tipos de autenticação são suportados pela ligação do Dynamics 365 Business Central:

      • Chave de acesso
      • OAuth 2.0 – Credenciais de cliente
      • Azure AD

      6. Para saber como configurar estes tipos de autenticação, consulte o artigo Configurar autenticação.

    6. Clicar em Seguinte.
  • Rever: reveja os detalhes da ligação e da autenticação.
  • Clique em Criar.

    • Configure a autenticação

    Introduza os detalhes com base na autenticação que quer usar.

    • Chave de acesso
      • Nome de utilizador: especifique o nome de utilizador da conta do Dynamics 365 OnPremise usada para autenticar no servidor do Microsoft Dynamics 365 Business Central.
      • Palavra-passe: selecione o segredo que contém a palavra-passe da conta do Dynamics 365 OnPremise.
      • Versão do Secret: selecione a versão do segredo.
      • Chave de acesso: especifique a chave de acesso usada para autenticar no Microsoft Dynamics 365 Business Central.
    • Credenciais de cliente OAuth 2.0
      • ID de cliente: especifique o ID de cliente da app que criou.
      • Segredo do cliente: especifique o segredo do Secret Manager que contém o segredo do cliente para a app associada que criou.
      • Versão do segredo: selecione a versão do segredo do cliente.
    • Azure AD
      • ID de cliente: especifique o ID de cliente usado para pedir tokens de acesso. Pode encontrar esta informação na vista geral da app associada criada no portal do Azure.
      • Âmbito: especifique uma lista de âmbitos desejados separados por vírgulas.
      • Client Secret: especifique o segredo do Secret Manager que contém a chave de acesso à conta.
      • URL de autorização: introduza o URL de autorização que gera quando cria um cliente OAuth. Introduza 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 ligação

    Esta secção apresenta os valores de exemplo para os vários campos que configura quando cria a associação.

    OAuth 2.0 – Tipo de ligação de credenciais de cliente

    Nome do campo Detalhes
    Localização europe-west1
    Conetor Dynamics365BusinessCentral
    Versão do conetor 1
    Nome da ligação dynamics-businesscentral-conn
    Ative o Cloud Logging Sim
    Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
    Inquilino do Azure 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 OAuth 2.0 – Credenciais de cliente
    ID do cliente fd04bae4-c30c-4faf-bbae-9263d4d96d61
    Segredo do cliente projects/617888503870/secrets/businesscentral-client-secret
    Versão do Secret 1

    Tipo de ligação da chave de acesso

    Nome do campo Detalhes
    Localização europe-west1
    Conetor Dynamics365BusinessCentral
    Versão do conetor 1
    Nome da ligação dynamics-businesscentral-on-prem-conn
    Ative o Cloud Logging Sim
    Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
    Inquilino do Azure 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 utilizador businesscentral
    Palavra-passe PASSWORD
    Versão do Secret 1
    Chave de acesso OQq9qggeWxt9iZPSWrs8wgfNjsAq06PT2uls7Luhbp8=
    Versão do Secret 1

    Tipo de ligação do Azure AD

    Nome do campo Detalhes
    Localização europe-west1
    Conetor Dynamics365BusinessCentral
    Versão do conetor 1
    Nome da ligação d365-business-central-oauth
    Ative o Cloud Logging Sim
    Conta de serviço my-service-account@my-project.iam.gserviceaccount.com
    Inquilino do Azure c9f472d9-7d8a-44cf-8ee0-458d32e26bce
    Empresa Altostart Ltd.
    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 AzureAD
    ID do cliente fd04bae4-c30c-4faf-bbae-9263d4d96d61
    Âmbitos https://api.businesscentral.dynamics.com/.default
    Segredo do cliente projects/617888503870/secrets/d365bc-secret
    Versão do Secret 3
    URL de autorização https://login.microsoftonline.com/c9f472d9-7d8a-44cf-8ee0-458d32e26bce/oauth2/v2.0/authorize

    Para obter informações sobre como criar um espaço de trabalho do Dynamics 365 Business Central, consulte o artigo Bem-vindo ao Dynamics 365 Business Central.

    Para obter 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 um máximo de 25 transações por segundo, por nó e limita todas as transações que excedam este limite. Por predefinição, os Integration Connectors atribuem 2 nós (para uma melhor disponibilidade) a uma ligação.

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

    Use a ligação do Dynamics 365 Business Central numa integração

    Depois de criar a ligação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

    • Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
    • Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

    Exemplos de operações de entidades

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

    Exemplo: apresentar todas as ordens 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, de seguida, clique em Concluído.
    4. Na secção Entrada de tarefas da tarefa Conectores, pode definir o filterClause.

      5. Tem de usar aspas simples (') para incluir o valor de uma cláusula de filtro. Pode usar a cláusula filter para filtrar registos com base nas colunas.

    Exemplo: obtenha uma nota de encomenda

    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, de seguida, 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 secção Mapeador de dados do Mapeamento de dados, clique em Abrir editor de mapeamento de dados e, em seguida, introduza "841c04f9-3391-ef11-8a6b-002248d4e29e" no campo Valor de entrada e escolha EntityId como variável local.

      O valor do ID da entidade deve ser transmitido diretamente, como "841c04f9-3391-ef11-8a6b-002248d4e29e". Aqui, "841c04f9-3391-ef11-8a6b-002248d4e29e" é o valor da chave principal exclusivo.

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

    Exemplo: elimine uma encomenda de vendas

    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, de seguida, 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 secção Mapeador de dados do Mapeamento de dados, clique em Abrir editor de mapeamento de dados e, em seguida, introduza "841c04f9-3391-ef11-8a6b-002248d4e29e" no campo Valor de entrada e escolha EntityId como variável local.

      Se a entidade tiver duas chaves empresariais ou principais compostas em vez de especificar o entityId, também pode definir a filterClause como id='841c04f9-3391-ef11-8a6b-002248d4e29e'.

    Exemplo: crie uma ordem 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, de seguida, clique em Concluído.
    4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como 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 da tarefa terá um valor semelhante ao seguinte:salesOrdersconnectorOutputPayload

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

    Exemplo: crie uma linha de encomenda de vendas

    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, de seguida, clique em Concluído.
    4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como 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 da tarefa terá um valor semelhante ao seguinte:salesOrderLinesconnectorOutputPayload

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

    Exemplo: crie um pedido de 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, de seguida, clique em Concluído.
    4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como 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 da tarefa terá um valor semelhante ao seguinte:salesQuotesconnectorOutputPayload

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

    Exemplo: crie uma nota de encomenda

    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, de seguida, clique em Concluído.
    4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como variável local. 
      {
     "vendorId": "7e0f75c5-f26e-ef11-a678-6045bdc89b07",
     "vendorNumber": "10000"
     }

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

      {
     "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, de seguida, clique em Concluído.
    4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como 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 da tarefa terá um valor semelhante ao seguinte:itemsconnectorOutputPayload

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

    Exemplo: atualize uma ordem de vendas

    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, de seguida, clique em Concluído.
    4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como variável local. 
      {
     "phoneNumber": "7764872993"
     }
    5. Defina o ID da entidade no mapeador de dados para a entidade de salesOrders. Para definir o ID da entidade, clique em Open Data Mapping Editor e, de seguida, introduza 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, também pode definir a filterClause como id ='5e9226d3-1c7b-ef11-a671-6045bdaef76c'.

    Exemplo: atualize uma linha de encomenda de vendas

    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, de seguida, clique em Concluído.
    4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como variável local. 
      {
     "description": "Test from Altostrat"
     }
    5. Defina o ID da entidade no mapeador de dados para a entidade de salesOrderLines. Para definir o ID da entidade, clique em Open Data Mapping Editor e, de seguida, introduza 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, também pode definir a filterClause como id ='35535130-d09d-ef11-8a6b-002248d4cc93'.

    Exemplo: atualize 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 Update e, de seguida, clique em Concluído.
    4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como variável local. 
      {
     "currencyCode": "USD"
     }
    5. Defina o ID da entidade no mapeador de dados para a entidade salesQuotes. Para definir o ID da entidade, clique em Open Data Mapping Editor e, de seguida, introduza 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, também pode definir a filterClause como id='2116bd4e-3ba3-ef11-8a6b-6045bdacfb5e'.

    Exemplo: atualize uma nota de encomenda

    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, de seguida, clique em Concluído.
    4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como variável local. 
      {
     "shipToName": "Charlie Cruz"
     }
    5. Defina o ID da entidade no mapeador de dados para a entidade de purchaseOrders. Para definir o ID da entidade, clique em Open Data Mapping Editor e, de seguida, introduza 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, 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, de seguida, clique em Concluído.
    4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como variável local. 
      {
     "displayName": "Updates Altostrat name"
     }
    5. Defina o ID da entidade no mapeador de dados para a entidade dos itens. Para definir o ID da entidade, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload/FilterClause como variável local.

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

    Obtenha ajuda da comunidade do Google Cloud

    Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

    O que se segue?