Salesforce

Descubra mais sobre o componente Salesforce e como utilizá-lo na Digibee Integration Platform.

O componente Salesforce permite que você realize operações na plataforma Salesforce.

Parâmetros

Dê uma olhada nos parâmetros de configuração do componente. Eles estão divididos em cinco abas: General, Authentication, Salesforce API, Advanced Settings e Documentation. Parâmetros suportados por expressões Double Braces estão marcados com (DB).

Aba General

Parâmetro	Descrição	Valor padrão	Tipo de dado
Fail On Error	Se a opção estiver ativada, a execução do pipeline com erro será interrompida. Do contrário, a execução do pipeline continua, mas o resultado vai mostrar um valor falso para a propriedade "success".	False	Booleano

Aba Authentication

Parâmetro	Descrição	Valor padrão	Tipo de dado
Operation Account	Define a conta que será usada para realizar as operações do Salesforce. Contas suportadas: Basic, Certificate-Chain.	N/A	Conta
Salesforce Login URL (DB)	Define a instância URL do Salesforce usada para a autenticação.	N/A	String
Salesforce Client Account	Define a conta do app Salesforce Connected que contém o ID do cliente. Deve ser uma conta do tipo Oauth-provider.	N/A	Conta tipo oauth-provider
OAuth Authentication Flow	Define a autenticação usada no app Salesforce. Opções: JWT Bearer Token Flow, Username-Password Flow.	N/A	String
Subject	Define o usuário usado para autenticação com o app Salesforce.	N/A	String

Aba Salesforce API

O componente Salesforce pode recuperar automaticamente todas as entidades disponíveis na plataforma Salesforce para auxiliar na configuração do componente.

Para usar essa funcionalidade, primeiro você deve configurar uma conta Salesforce válida e uma opção de URL Salesforce. Se uma conta ou URL inválida é configurada, o componente iá permitir apenas o modo de uso RAW. Isso quer dizer que a requisição deverá ser configurada manualmente. Este comportamento também se aplica se nenhuma conta estiver selecionada no parâmetro Operation Account.

AuthToken Reuse

Ao configurar o conector Salesforce e acessar a aba Salesforce API, um token é gerado automaticamente. No entanto, esse token tem um tempo de vida limitado e pode expirar com o tempo ou devido ao número de acessos.

Para evitar a necessidade de gerar novos tokens durante a configuração, a Digibee desenvolveu o mecanismo AuthToken Reuse para fluxos usuário-senha. Com ele, é possível configurar uma nova conexão diretamente no portal Salesforce, permitindo a reutilização do token gerado.

Consulte a documentação para saber como configurar esse mecanismo.

Parâmetro	Descrição	Valor padrão	Tipo de dado
API Version	Define a versão da API do Salesforce.	{última versão}	String
APIs	Define a API do Salesforce API a ser acessada. As opções disponíveis são Rest, Bulk, Bulk 2.0 e RAW.	N/A	String
Operation	Define a operação a ser realizada na API do Salesforce. Veja abaixo na seção correspondente as opções disponíveis para cada API.	N/A	String
Object Name	Define o SObject a ser tratado na requisição.	N/A	String
Interactive Mode	Se a opção estiver ativada, o componente Salesforce espera ser configurado por campos individuais com base no SObject selecionado. Do contrário, o componente espera um objeto JSON completo que contém todos os dados SObject necessários.	False	Booleano

RAW

Quando o parâmetro APIs estiver configurado como RAW, os seguintes parâmetros serão apresentados para a configuração manual da requisição:

Parâmetro	Descrição	Valor padrão	Tipo de dado
Method	Define o método HTTP.	GET	String
Path (DB)	Define o caminho do serviço de API Salesforce API a ser requisitado.	N/A	String
Headers (DB)	Define todos os tipos de headers necessários para a requisição.	N/A	String
Query params (DB)	Define os parâmetros de consulta (query parameters) necessários para a requisição.	N/A	String
Body (DB)	Define o body da requisição.	N/A	JSON

Aba Advanced settings

Parâmetro	Descrição	Valor padrão	Tipo de dado
Send NULL values	Define se os campos SObject com valores null values devem ser considerados pela API Salesforce. Por padrão, o Salesforce ignora SObjects com campos null.	False	Booleano

Aba Documentation

Parâmetro	Descrição	Valor padrão	Tipo de dado
Documentation	Sectão para documentar qualquer informação necessária sobre a configuração do componente e regras de negócio.	N/A	String

Opções disponíveis para o parâmetro Operation

Bulk:

• Abort Job

• Close Job

• Create Batch

• Create Batch Query

• Create Job

• Get All Batches

• Get Batch

• Get Job

• Get Query Result

• Get Query Result Ids

• Get Request

• Get Results

Bulk 2.0:

• Abort Job

• Abort Query Job

• Close Job

• Create Batch

• Create Job

• Create Query Job

• Delete Job

• Delete Query Job

• Get All Jobs

• Get All Query Jobs

• Get Failed Results

• Get Job

• Get Query Job

• Get Query Job Results

• Get Successful Results

• Get Unprocessed Records

Rest:

• Apex Call

• Approval

• Approvals

• Composite

• Composite-batch

• Composite Create SObject Collections

• Composite Delete SObject Collections

• Composite Retrieve SObject Collections

• Composite-tree

• Composite Update SObject Collections

• Composite Upsert SObject Collections

• Create SObject

• Delete SObject

• Delete SObject With Id

• Get Basic Info

• Get Blob Field

• Get Description

• Get Global Objects

• Get Resources

• Get SObject

• Get SObject With Id

• Get Versions

• Limits

• Query

• Query All

• Query More

• Recent

• Search

• Update SObject

• Upsert SObject

Informações adicionais - operação Composite

Ao usar a operação Composite, é importante remover o caminho completo da propriedade url para garantir o comportamento correto do componente. Considere o exemplo abaixo:

Body

 {
            "method": "POST",
            "url": "/services/data/v59.0/sobjects/Account",
            "referenceId": "refAccount",
            "body": {
                "Name": "Sample Account"
            }
        }

Nesse caso, o trecho a seguir deve ser removido da propriedade url:

/services/data/v59.0

Após editar a propriedade, o exemplo correto deve aparecer dessa forma:

Body

{
            "method": "POST",
            "url": "/sobjects/Account",
            "referenceId": "refAccount",
            "body": {
                "Name": "Sample Account"
            }
        }

Informações adicionais - operações Query

Ao usar qualquer operação Query (como Query, Query All, Query More), você deve usar o padrão conforme o exemplo abaixo:

Body

{
"q": "SELECT Id, LastName, Company FROM Lead ORDER BY CreatedDate DESC LIMIT 05"
}

Se você deseja usá-lo com expressões Double Braces, então faça da seguinte forma:

{
"q": " {{ message.query }}"
}