FinancialForce

O conector da Financial Force permite realizar operações de inserção, exclusão, atualização e leitura em um banco de dados da Financial Force.

Antes de começar

Antes de usar o conector do FinancialForce, realize as seguintes tarefas:

  • 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 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.

      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 FinancialForce 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. Se quiser, 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.

    8. Token de segurança: o token de segurança usado para autenticar o acesso à conta do FinancialForce.
    9. Versão da API: a versão da API FinancialForce usada.A versão da API FinancialForce usada por padrão é a 40.0.
    10. Todas ou nenhuma: um booleano que indica se você quer que todas as inserções, atualizações ou exclusões falhem em uma solicitação se até mesmo um único registro falhar.
    11. Modo de arquivo: booleano que indica se é necessário incluir registros excluídos e arquivados com uma consulta SELECT padrão.
    12. Modo de simultaneidade da API Bulk: o modo de simultaneidade para processar linhas em massa com a API BULK v1.
    13. Versão da API Bulk: a versão da API Bulk a ser usada para processar consultas.
    14. Intervalo de pesquisa em massa: é o intervalo de tempo em milissegundos entre as solicitações que verificam a disponibilidade da resposta da consulta em massa. O valor padrão é 500 ms.
    15. Tempo limite da consulta em massa: o tempo limite em minutos que o provedor aguardará a resposta da consulta em massa. O valor padrão é 25 minutos.
    16. Continuar em caso de exceção de alteração: indica se você quer continuar após uma instrução ALTER falhar.
    17. Escopo do filtro: escopo opcional para limitar os registros retornados das consultas.
    18. Incluir descrição de metadados: defina esta propriedade como um valor diferente de NENHUM se você quer recuperar as descrições de colunas, tabelas ou ambas da API de metadados.
    19. Agregação do lado do servidor: um valor booleano que determina se a agregação do lado do servidor precisa ser usada.
    20. Tempo limite da sessão: o tempo em minutos em que uma sessão de login do FinancialForce é reutilizada.
    21. Ignorar campos de fórmula: defina como "true" se os campos de fórmula precisam ser ignorados ao listar colunas.
    22. Usar nomes de exibição: booleano determina se os nomes de exibição das colunas devem ser usados no lugar dos nomes da API.
    23. Usar sandbox: um booleano que determina se a conexão deve ser feita com uma conta sandbox do FinancialForce.
    24. Visualizações definidas pelo usuário: um caminho que aponta para o arquivo de configuração JSON que contém suas visualizações personalizadas.
    25. Aguardar resultados em massa: define se os resultados em massa serão aguardados ao usar a API assíncrona. Ativo apenas quando UseBulkAPI é verdadeiro.
    26. 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:

    27. Outra opção é clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
    28. 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.

      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 Next.
  6. Na seção Autenticação, insira os detalhes da autenticação.
    1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      A conexão da FinancialForce oferece suporte aos seguintes tipos de autenticação:

      • Nome de usuário e senha

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

    2. Clique em Next.
  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.

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.

  • 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:

    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 e um de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Usar o Terraform para criar conexões

Use o recurso do Terraform para criar uma nova conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Para conferir um exemplo de modelo do Terraform para criação de conexão, consulte exemplo de modelo.

Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro Tipo de dados Obrigatório Descrição
security_token SECRET Falso O token de segurança usado para autenticar o acesso à conta do FinancialForce.
apiversion STRING Falso A versão da API FinancialForce usada. A versão da API FinancialForce usada por padrão é 40.0.
all_or_none BOOLEAN Falso Um valor booleano que indica se você quer que todas as inserções, atualizações ou exclusões falhem em uma solicitação se houver falha em um único registro.
archive_mode BOOLEAN Falso Booleano que indica se é necessário incluir registros excluídos e arquivados com uma consulta SELECT padrão.
bulk_apiconcurrency_mode ENUM Falso O modo de simultaneidade para processar linhas em massa com a API BULK v1. Os valores aceitos são: Serial, Parallel
bulk_apiversion ENUM Falso A versão da API em massa a ser usada para processamento de consultas. Os valores aceitos são: v1, v2
bulk_polling_interval STRING Falso O intervalo de tempo em milissegundos entre as solicitações que verificam a disponibilidade da resposta da consulta em massa. O valor padrão é 500 ms.
bulk_query_timeout STRING Falso O tempo limite em minutos que o provedor vai aguardar uma resposta de consulta em massa. O valor padrão é 25 minutos.
continue_on_alter_exception BOOLEAN Falso Se você quer continuar depois que uma instrução ALTER falhar.
filter_scope ENUM Falso Escopo opcional para limitar os registros retornados de consultas. Os valores aceitos são: None, Delegated, Everything, Mine, MineAndMyGroups, My_Territory, My_Team_Territory, Equipe
include_metadata_description ENUM Falso Defina essa propriedade como um valor diferente de NENHUM se você quiser recuperar as descrições de colunas, tabelas ou ambas da API Metadata. Os valores aceitos são: NONE, Columns, Tables, TablesAndColumns
server_side_aggregation BOOLEAN Falso Um booleano que determina se a agregação do lado do servidor precisa ser usada.
session_timeout STRING Falso O tempo em minutos em que uma sessão de login do FinancialForce é reutilizada.
skip_formula_fields BOOLEAN Falso Defina como verdadeiro caso os campos de fórmula precisem ser ignorados ao listar colunas.
use_display_names BOOLEAN Falso Booleano que determina se os nomes de exibição das colunas devem ser usados em vez dos nomes da API.
use_sandbox BOOLEAN Verdadeiro Um booleano que determina se a conexão deve ser feita com uma conta sandbox do FinancialForce.
user_defined_views STRING Falso Um caminho que aponta para o arquivo de configuração JSON que contém suas visualizações personalizadas.
wait_for_bulk_results BOOLEAN Falso Define se é necessário aguardar resultados em massa ao usar a API assíncrona. Só é ativado quando UseBulkAPI é verdadeiro.
proxy_enabled BOOLEAN Falso Marque esta caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme ENUM Falso O tipo de autenticação a ser usado para autenticar no proxy ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user STRING Falso Um nome de usuário a ser usado para autenticar no proxy ProxyServer.
proxy_password SECRET Falso Uma senha a ser usada para autenticar no proxy ProxyServer.
proxy_ssltype ENUM Falso O tipo de SSL a ser usado ao se conectar ao proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL

Usar a conexão do FinancialForce em uma integração

Depois que você cria a conexão, ela fica disponível nos Apigee Integration 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 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