Salesforce

Exemplos de configuração de conexão

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

Tipo de conexão com nome de usuário e senha

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:
  • 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 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 parâmetro 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.

Ações

Com esse conector, você realiza operações de inserção, exclusão, atualização e leitura nos dados do Salesforce. Para executar consultas SQL personalizadas, o conector oferece a ação Executar consulta personalizada.

Para criar uma consulta salva, siga estas etapas:

1. Siga as instruções detalhadas para adicionar uma tarefa de conectores.
2. Quando você configurar a tarefa do conector, selecione Ações no tipo de ação que você quer realizar.
3. Na lista Ação, selecione Executar consulta personalizada e clique em Concluído.

   

4. Expanda a seção Entrada de tarefas e faça o seguinte:
   1. No campo Tempo limite após, digite o número de segundos de espera até que a consulta seja executada.

      Valor padrão: 180 segundos

   2. No campo Número máximo de linhas, digite o número máximo de linhas a serem retornadas do banco de dados.

      Valor padrão: 25.

   3. Para atualizar a consulta personalizada, clique em Editar script personalizado. A caixa de diálogo Editor de script é aberta.

      

   4. Na caixa de diálogo Editor de script, insira a consulta SQL e clique em Salvar.

      É possível usar um ponto de interrogação (?) em uma instrução SQL para representar um único parâmetro que precisa ser especificado na lista de parâmetros de consulta. Por exemplo, a seguinte consulta SQL seleciona todas as linhas da tabela Employees que correspondem aos valores especificados na coluna LastName:

      SELECT * FROM Employees where LastName=?

   5. Se você usou pontos de interrogação na consulta SQL, adicione o parâmetro clicando em + Adicionar nome do parâmetro para cada ponto de interrogação. Ao executar a integração, esses parâmetros substituem os pontos de interrogação (?) na consulta SQL sequencialmente. Por exemplo, se você tiver adicionado três pontos de interrogação (?), deverá adicionar três parâmetros em ordem de sequência.

      

      Para adicionar parâmetros de consulta, faça o seguinte:

      1. Na lista Tipo, selecione o tipo de dados do parâmetro.
      2. No campo Valor, insira o valor do parâmetro.
      3. Para adicionar vários parâmetros, clique em + Adicionar parâmetro de consulta.

O conector do Salesforce não aceita valores parametrizados para a cláusula OFFSET, e ela não pode ser substituída dinamicamente usando parâmetros de consulta. No entanto, os parâmetros de consulta são aceitos na cláusula WHERE.

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

Ação CreateJobv2

Use essa ação para criar um job.

Parâmetros de entrada da ação CreateJobV2

Para ver um exemplo de como configurar a ação CreateJobV2, consulte Exemplos.

Ação UploadJobDataV2

Use essa ação para fazer upload de um arquivo de job no formato CSV para o Salesforce.

Parâmetros de entrada da ação UploadJobDataV2

Para ver um exemplo de como configurar a ação UploadJobDataV2, consulte Exemplos.

Ação CreateBatch

Essa ação cria um lote do Salesforce.

Parâmetros de entrada da ação CreateBatch

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

Para ver um exemplo de como configurar a ação CreateBatch, consulte Exemplos.

Ação CreateJob

Essa ação adiciona uma entrada de objeto do Salesforce.

Parâmetros de entrada da ação CreateJob

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

Para ver um exemplo de como configurar a ação CreateJob, consulte Exemplos.

Ação GetBatch

Essa ação recebe informações sobre um lote do Salesforce.

Parâmetros de entrada da ação GetBatch

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

Para ver um exemplo de como configurar a ação GetBatch, consulte Exemplos.

Ação GetJob

Essa ação recebe informações sobre um job do Salesforce.

Parâmetros de entrada da ação GetJob

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

Para ver um exemplo de como configurar a ação GetJob, consulte Exemplos.

Ação UploadAttachment

Essa ação faz upload de um anexo e o associa a uma entidade no Salesforce.

Parâmetros de entrada da ação UploadAttachment

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

Para ver um exemplo de como configurar a ação UploadAttachment, consulte Exemplos.

Ação GetBatchResults

Essa ação recebe os resultados de um lote do Salesforce.

Parâmetros de entrada da ação GetBatchResults

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

Para ver um exemplo de como configurar a ação GetBatchResults, consulte Exemplos.

Exemplos de ações

Exemplo: CreateJobV2

Este exemplo cria um job.

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

    {
     "ObjectName": "Contact",
     "Action": "insert"
    }

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

 
  [{
  "ID": "750dM000005HjdnQAC",
  "State": "Open",
  "JobType": null,
  "ContentUrl": "services/data/v43.0/jobs/ingest/750dM000005HjdnQAC/batches",
  "ContentType": "CSV",
  "CreatedDate": "2024-08-07T09:16:16.000+0000",
  "CreatedById": "005dM0000061WSFQA2",
  "ConcurrencyMode": "Parallel",
  "SystemModStamp": "2024-08-07T09:16:16.000+0000"
  }] 

Exemplo: UploadJobDataV2

Este exemplo faz upload de um arquivo de job para o Salesforce.

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

    {
     "Content":   "FirstName,LastName,Email,MobilePhone,External_Id__c\\nGinelle,Merioth,gmerioth0@example.com,851-555-8435,4d13cac0-2c11-48e9-891d-49ee9508a6c7\\nDalli,Tumilson,dtumilson1@example.com,881-555-6742,38bcb24b-247f-498b-9502-c98995a1e04b\\nRobbin,Purveys,rpurveys2@example.com,732-555-6909,35d96c7a-3856-4809-8c49-35ddb9fa7dd9\\nLothaire,Ivanchenkov,livanchenkov3@example.com,144-555-1959,75f63f26-6f4a-406f-a9f4-807f4a8a7b51",
     "ContentUrl": "services/data/v43.0/jobs/ingest/750dM000005HjdnQAC/batches"
    }

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

 
  [{
  "Uploaded": "true"
  }]

Exemplo: CreateBatch

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CreateBatch e clique em Concluído.
3. Na seção Mapeamento de dados Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input:

   {
   "JobId": "750dL000007EipxQAC",
   "Aggregate": "\n    Walter\n    White\n  \n  \n    Rob\n    Brown\n  \n",
   "ContentType": "XML"
   }

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

 
[{
  "ID": "751dL000003ziC5QAI",
  "JobID": "750dL000007EipxQAC",
  "ApexProcessingTime": "0",
  "ApiActiveProcessingTime": "0",
  "CreatedDate": "2024-09-03T04:48:53.000Z",
  "NumberRecordsFailed": "0",
  "NumberRecordsProcessed": "0",
  "State": "Queued",
  "StateMessage": null,
  "SystemModstamp": "2024-09-03T04:48:53.000Z",
  "TotalProcessingTime": "0"
}]

Exemplo: CreateJob

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CreateJob e clique em Concluído.
3. Na seção Mapeamento de dados Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input:

   {
     "ObjectName": "Campaign",
     "Action": "insert"
   }

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

 
 [{
  "ID": "750dL000007GgD7QAK",
  "JobID": "750dL000007GgD7QAK",
  "ObjectName": "Campaign",
  "Operation": "insert",
  "ApiVersion": "56.0",
  "ApexProcessingTime": "0",
  "ApiActiveProcessingTime": "0",
  "AssignmentRuleId": null,
  "ConcurrencyMode": "Parallel",
  "ContentType": "XML",
  "CreatedById": "005dL000007CalFQAS",
  "CreatedDate": "2024-09-03T05:31:41.000Z",
  "ExternalIdFieldName": null,
  "NumberBatchesCompleted": "0",
  "NumberBatchesQueued": "0",
  "NumberBatchesFailed": "0",
  "NumberBatchesInProgress": "0",
  "NumberBatchesTotal": "0",
  "NumberRecordsFailed": "0",
  "NumberRecordsProcessed": "0",
  "NumberRetries": "0",
  "State": "Open",
  "SystemModStamp": "2024-09-03T05:31:41.000Z",
  "TotalProcessingTime": "0"
}]

Exemplo: GetBatch

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação GetBatch e clique em Concluído.
3. Na seção Mapeamento de dados Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input:

   {
     "BatchId": "751dL000003yKlJQAU",
     "JobId": "750dL000007EipxQAC"
   }

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

 
[{
  "ID": "751dL000003yKlJQAU",
  "JobID": "750dL000007EipxQAC",
  "ApexProcessingTime": "0",
  "ApiActiveProcessingTime": "0",
  "CreatedDate": "2024-09-02T11:44:15.000Z",
  "NumberRecordsFailed": "0",
  "NumberRecordsProcessed": "0",
  "State": "Failed",
  "StateMessage": "InvalidBatch : Failed to parse XML. Unexpected XML element 'sObject' found at  START_TAG seen ... @1:9 it should be 'sObjects'",
  "SystemModstamp": "2024-09-02T11:44:15.000Z",
  "TotalProcessingTime": "0"
}]

Exemplo: GetJob

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação GetJob e clique em Concluído.
3. Na seção Mapeamento de dados Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input:

   {
     "JobId": "750dL000007EipxQAC"
   } 

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

 
[{
  "ID": "750dL000007EipxQAC",
  "JobID": "750dL000007EipxQAC",
  "ObjectName": "Campaign",
  "Operation": "insert",
  "ApiVersion": "56.0",
  "ApexProcessingTime": "0",
  "ApiActiveProcessingTime": "0",
  "AssignmentRuleId": null,
  "ConcurrencyMode": "Parallel",
  "ContentType": "XML",
  "CreatedById": "005dL000007CalFQAS",
  "CreatedDate": "2024-09-02T11:17:42.000Z",
  "ExternalIdFieldName": null,
  "NumberBatchesCompleted": "0",
  "NumberBatchesQueued": "0",
  "NumberBatchesFailed": "2",
  "NumberBatchesInProgress": "0",
  "NumberBatchesTotal": "2",
  "NumberRecordsFailed": "0",
  "NumberRecordsProcessed": "0",
  "NumberRetries": "0",
  "State": "Open",
  "SystemModStamp": "2024-09-02T11:17:42.000Z",
  "TotalProcessingTime": "0"
}]

Exemplo: UploadAttachment

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UploadAttachment e clique em Concluído.
3. Na seção Mapeamento de dados Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input:

   {
     "ObjectId": "001dL00000SC6j7QAD",
     "FileName": "My files/salesforce/con.csv",
     "Base64Data": "Y29ubmVjdG9ycyBpcyBiYWNr"
   }

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

 
[{
  "Id": "00PdL000000EJUDUA4"
}]

Exemplo: GetBatchResults

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação GetBatchResults e clique em Concluído.
3. Na seção Mapeamento de dados Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input:

   {
     "BatchId": "751dL000004D17FQAS",
     "JobId": "750dL000007XKUhQAO",
     "ContentType": "XML"
   }

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

 
[{
  "ID": null,
  "Created": "false",
  "Success": "false",
  "Errors_Fields": "LastName",
  "Errors_Message": "Account: bad field names on insert/update call: FirstName, LastName",
  "Errors_StatusCode": "INVALID_FIELD_FOR_INSERT_UPDATE"
}, {
  "ID": null,
  "Created": "false",
  "Success": "false",
  "Errors_Fields": "LastName",
  "Errors_Message": "Account: bad field names on insert/update call: FirstName, LastName",
  "Errors_StatusCode": "INVALID_FIELD_FOR_INSERT_UPDATE"
}]

Exemplos de operações de entidade

Nesta seção, mostramos como realizar algumas das operações de entidade neste conector.

Exemplo: criar um anexo

A API "Entity create attachment" cria apenas um anexo sem um arquivo de conteúdo. Para adicionar um arquivo, precisamos realizar a ação "Fazer upload de anexo" fornecendo um contexto de arquivo na entrada.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione "Anexo" na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Mapeador de dados da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

   {
     "Name": "New Attachment",
     "Description": "New created attachment",
     "ParentId": "001dL00000SC6j7QAD",
     "Body": "Body"
   }
   

5. A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

   {
     "Id": "00PdL000000EJKXUA4"
   }
   

Exemplo: atualizar um anexo

O anexo de atualização de entidade só atualiza o nome ou a descrição do anexo. Para adicionar um arquivo, precisamos realizar a ação "Fazer upload de anexo" fornecendo um contexto de arquivo na entrada.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione "Anexo" na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Defina o ID da entidade para atualizar um anexo. Para definir o ID da entidade, na seção Data mapper das Tarefas, clique em EntityID e insira 00PdL000000EJKXUA4 no campo indicado.
5. Na seção Mapeador de dados da Tarefa, clique no editor OpenDataMapping e insira um valor semelhante ao seguinte em field:

   {
     "Name": "New Attachment",
     "Description": "New updated attachment",
     "Body": "Body"
   }
   

Como alternativa, em vez de especificar o entityId, você também pode definir a filterClause como 00PdL000000EJKXUA4.

6. A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

   {
     "Id": "00PdL000000EJKXUA4"
   }