Acumatica

Com o conector da Acumatica, você pode realizar operações de inserção, exclusão, atualização e leitura em um banco de dados da Acumatica.

Antes de começar

Antes de usar o conector da Acumatica, faça o seguinte:

• No seu projeto do Google Cloud, faça o seguinte:
  • Conceda a função IAM roles/connectors.admin ao usuário que está configurando o conector.
  • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

  • 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 a Acumatica

Para mais informações sobre a instalação do Acumatica ERP, consulte Instalar o Acumatica ERP.

A instância do ERP do Acumatica vem com uma conta de usuário padrão que pode ser usada para fazer login no sistema. Você pode começar a trabalhar com o Acumatica ERP depois de mudar a senha do usuário padrão.

1. Para iniciar a instância do aplicativo, clique em Perform Application Maintenance na página inicial do assistente de configuração do Acumatica ERP .
2. Clique no link gerado automaticamente no grupo do programa ERP da Acumatica.
3. Acesse http://localhost/INSTANCE_NAME no navegador da Web e digite INSTANCE_NAME; o nome especificado no campo do diretório virtual durante a configuração.

Se você usou o nome padrão para o diretório virtual durante a implantação da instância, use http://localhost/AcumaticaERP/.

O URL http://localhost/INSTANCE_NAME funciona somente no computador local onde você instalou o Acumatica ERP Tools. Para acessar a instância do ERP do Acumatica remotamente, use o nome de domínio totalmente qualificado (FQDN, na sigla em inglês) do servidor em vez do localhost no URL.

4. Insira o seguinte na página de login:
5. Nome de usuário: digite "admin" como nome de usuário.
6. Senha: digite a senha.
7. Clique em Sign In.
8. Digite a nova senha na coluna Nova senha e clique em Confirmar senha.
9. Clique em Contrato do usuário da Acumatica e leia o contrato do usuário.
10. Selecione Verificar aqui para indicar que você leu e concorda com os termos do contrato de usuário da Acumatica e com eles.
11. Clique em Sign In.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). 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, siga estas etapas:

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.

      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 Acumatica 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. Opcionalmente, 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 qualquer 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.

   Observação: você só poderá personalizar os valores do nó de conexão se for um cliente de pagamento por utilização.
   8. Empresa: Your Acumatica Company.
   9. Nome do endpoint: o nome do endpoint no Acumatica WebService que você quer acessar. Os endpoints disponíveis estão disponíveis no formulário "Endpoints de serviço da Web" no Acumatica ERP.
   10. Versão do endpoint: a versão do endpoint. Os endpoints disponíveis estão disponíveis no formulário Web Service Endpoints no Acumatica ERP. A versão deles está disponível em "Versão do endpoint".
   11. Tabelas de consulta: tabelas de consulta separadas por vírgulas. As tabelas de consulta no contrato 3 da API Acumatica versão 17.200.001 são: AccountByPeriodInquiry, AccountBySubaccountInquiry, AccountDetailsInquiry, AccountSummaryInquiry, InventoryAllocationInquiry, InventorySummaryInquiry, InvoicedItemsInquiry, SalesPricesInquiry, VendorPricesInquiry.
   12. Esquema: usado para especificar qual API Acumatica deve ser usada. O padrão é a API REST Contact. Quando o OData é especificado, a API OData é usada, e todas as consultas genéricas expostas pelo OData são recuperadas dinamicamente.
   13. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
   • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Básico: autenticação HTTP básica.
     • Resumo: autenticação HTTP de resumo.
   • Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
   • Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
   • Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
     • Sempre: a conexão será sempre com SSL ativado.
     • Nunca: a conexão não está com SSL ativado.
     • Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
   • Na seção Servidor proxy, insira os detalhes do servidor proxy.
     1. Clique em + Adicionar destino.
     2. Selecione um Tipo de destino.
        • Endereço do host: especifique o nome do host ou o endereço IP do destino.

          Se quiser estabelecer uma conexão privada com seu sistema de back-end, faça o seguinte:

          • Crie um anexo do serviço PSC.
          • Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
   14. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
   15. Clique em PRÓXIMA.
5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
   1. Tipo de destino: selecione um Tipo de destino.
      • Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
      • Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.
        Observação : para entender como criar um anexo de endpoint, consulte Anexo de serviço PSC e anexo de endpoint. Depois de ter criado o anexo de endpoint, ele vai aparecer na lista Anexo do endpoint.

      Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.

      Para inserir outros destinos, clique em +ADICIONAR DESTINO.

   2. Clique em PRÓXIMA.
6. Na seção Autenticação, insira os detalhes da autenticação.
   1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      Os seguintes tipos de autenticação são suportados pela conexão Acumatica:

      • Nome de usuário e senha

   Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

   2. Clique em PRÓXIMA.
7. Revisão: revise os detalhes de conexão e autenticação.
8. Clique em Criar.

Configurar a autenticação

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

• Nome de usuário e senha
  • Nome de usuário: nome de usuário para o conector
  • Senha: a senha do Secret Manager que contém a senha associada ao conector.

Exemplos de configuração de conexão

Esta seção lista os valores de amostra para os vários campos configurados ao criar a conexão do Acumatica.

Tipo de conexão REST

Nome do campo	Detalhes
Local	europe-west1
Conector	Acumatica
Versão do conector	1
Nome da conexão	acumatica
Ativar Cloud Logging	Falso
Conta de serviço	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Nível de verbosidade	5
Número mínimo de nós	2
Número máximo de nós	50
Host	https://examplepetstore.com
Nome de usuário	NOME DE USUÁRIO
Senha	SENHA
Versão do secret	1

Tipo de conexão OData

Nome do campo	Detalhes
Local	europe-west1
Conector	Acumatica
Versão do conector	1
Nome da conexão	acumatica
Ativar Cloud Logging	Falso
Conta de serviço	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Empresa	Exemplo de organização
Versão do endpoint	22.200.001
Tabela de consultas	PX_Objects_AP_APInvoice
Esquema	OData
Nível de verbosidade	5
Número mínimo de nós	2
Número máximo de nós	50
Host	https://examplepetstore.com
Nome de usuário	NOME DE USUÁRIO
Senha	SENHA
Versão do secret	1

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

Observação:você pode ver as entidades, as operações e as ações de um conector na tarefa de conectores.

• Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
  • Lista
  • Receber
  • Criar
  • Atualizar
  • Excluir

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações sem suporte não serão listadas na lista Operations.

• Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada, . No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Observação: todas as entidades e ações terão um esquema associado a elas. Por exemplo, um esquema de ação terá os detalhes do parâmetro como: o parâmetro e o tipo de dados correspondente. O esquema (metadados) de entidades e ações é buscado pela conexão em do seu back-end. Se houver atualizações no esquema, elas não serão refletidas automaticamente nas suas conexões. Faça isso manualmente. Para atualizar o esquema de uma conexão, abra a página Detalhes da conexão e clique em Atualizar esquema de conexão.

Limitações do sistema

O conector da Acumatica pode processar uma transação por segundo, por nó, e limita todas 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.

Observação: o número de nós de Integration Connectors vai ser escalonado automaticamente de forma dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes sem esperar pelo escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processa menos transações. Para configurar os valores do nó, faça o seguinte:

• Se você é um cliente de pagamento por uso, configure os valores mínimo e máximo do nó na página "Editar conexão".
• Se você for um cliente de assinatura, entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para melhorar a capacidade de processamento, verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

Ações

Esta seção lista as ações compatíveis com o conector. Para saber como configurar ações, consulte os Exemplos de ação.

Observação: os resultados de todas as ações vão estar disponíveis como uma resposta JSON no parâmetro de resposta connectorOutputPayload da tarefa Connectors após a execução da integração.

Ação ExecuteAction

Essa ação permite executar uma ação.

Parâmetros de entrada da ação ExecuteAction

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
ActionName	String	Não	O nome da ação que você vai executar.
EntityRecord	String	Não	O registro de entidade no formato JSON ou a tabela temporária de registros de entidade à qual a ação deve ser aplicada.
Parâmetros	String	Não	Os parâmetros da ação no formato JSON.
TopLevelEntity	String	Não	O nome do tipo de entidade em que você vai executar uma ação.

Parâmetros de saída da ação ExecuteAction

Essa ação retorna a mensagem de confirmação da ExecuteAction.

Por exemplo, sobre como configurar a ação ExecuteAction, consulte Exemplos.

Exemplos de ação

Exemplo: executar uma ação

Esta ação executa a ação especificada.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação ExecuteAction e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
   "ActionName": "PrintSalesOrder",   
   "TopLevelEntity": "SalesOrder"
   "EntityRecord": "{
   "Type": {
     "value": "IN"
   },
   "OrderNbr": {
     "value": "000007"
   },
   "CustomerID": {
     "value": "CANDYY"
   },
   "LocationID": {
     "value": "MAIN"
   }}}"

Se a ação for bem-sucedida, o ExecuteAction resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

[{
"Status": "Success",   
"AffectedRecords": "1"
}] 

Exemplos de operações de entidade

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

Exemplo: listar todos os clientes

Este exemplo lista todos os clientes na entidade Customer.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Customer na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Na seção Entrada de tarefa da tarefa Conectores, você também pode filtrar o conjunto de resultados especificando uma cláusula de filtro. Especifique o valor da cláusula de filtro sempre entre aspas simples (").

Exemplo: receber um PurchaseOrder

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione PurchaseOrder na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Defina o ID da entidade como "Get single PurchaseOrder". Para definir o ID da entidade, na seção Data Mapper do Mapeamento de dados, clique em Abrir editor de mapeamento de dados e digite 000001 no campo Valor de entrada e escolha o EntityId como variável local.

Exemplo: excluir uma conta

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Account na lista Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Defina o ID da entidade como "Excluir conta". Para definir o ID da entidade, em Na seção Mapeador de dados de Mapeamento de dados, clique em Abrir editor de mapeamento de dados e Em seguida, insira 10250 no campo Valor de entrada e escolha "EntityId" como a variável local.

Exemplo: criar uma transação de diário

Este exemplo cria um registro na entidade JournalTransaction.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione JournalTransaction na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
       "Description": "go again",   
       "BatchNbr": "000008",   
       "CurrencyID": "INR",   
       "Module": "GL" 
   }
     

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá uma semelhante a:

   [{
       "BatchNbr": "000016",   "Module": "GL" 
   }]
        

Exemplo: atualizar um pedido de vendas

Este exemplo atualiza um registro na entidade SalesOrder.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione SalesOrder na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
         "Approved": true,   
         "Description": "SO--0014"       
    }
        

5. Clique em entityId e insira 000025. no campo Valor padrão.

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá uma semelhante a:

   [{
         "OrderNbr": "000025",   
         "OrderType": "CS"
   }]
     

Usar a conexão da Acumatica em uma integração

Depois de criar a conexão, ela fica disponível na integração da Apigee e na integração do aplicativo. Você pode usar a conexão em uma integração pela tarefa 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 integração de aplicativos, consulte Tarefa "Conectores".

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

• Entenda como suspender e retomar uma conexão.
• Entenda como monitorar o uso do conector.
• Saiba como acessar os registros do conector.