Skip to main content

Salesforce

Salesforce 连接器助您在 Designer 中连接至 Salesforce

Salesforce is available as a data source in the Input Data tool and Output Data tool, and as the standalone Salesforce Input and Salesforce Output tool.

Designer 中的新连接器版本

Salesforce 连接器现在是 Alteryx One 连接器体验的一部分。请仔细阅读此页面上的信息,以确保您正确使用相应的工具。

如果您想更新 Designer 工作流中的 Salesforce 连接器,可以使用工作流迁移实用程序

Salesforce 连接器详细信息

Salesforce 已在 Designer 2025.2 补丁 3 或更高版本中作为输入数据工具的数据源提供。如需详细了解文件类型选项,请转至 [links]。

Prerequisites

Ensure you have completed the following prerequisites before proceeding:

Requirement

Detail

Designer version

  • 2025.1 Patch 5, 2025.2 Patch 3, or 2026.1 or later (all features except Built-in and Custom OAuth)

  • 2025.1.2 Patch 7, 2025.2.1 Patch 5, or 2026.1 Patch (all auth methods)

Custom app (OAuth 2.0) setup, if used

A Salesforce Connected App with Client ID, Client Secret, Redirect URI (must match the connected app) and scope

Environment URL

Production (default), Sandbox or, Custom domain

DCM

You must enable DCM in Designer. Go to Options > Advanced Settings > DCM to enable it

安装连接器

通过附加组件,您可以轻松从 Designer 安装最新版本的 Salesforce 连接器。如果以这种方式安装连接器,则无需访问 Alteryx Marketplace。

要安装连接器…

  1. Designer 中,转至附加组件 > 管理 Marketplace 附加组件

  2. Designer 将打开一个包含可用连接器列表的窗口。

  3. 键入 Salesforce 进行搜索。

使用 DCM 设置连接

要使用 DCM 连接到 Salesforce...DCM - Designer

  1. 将输入数据或输出数据工具从工具面板拖到画布上并选择它。

  2. 如果您之前创建过 Google Drive 连接,则可以选择数据源 > Salesforce > 快速连接,然后跳至第 12 步

    If you've created a Salesforce connection before, you can select the connection from the Recents tab.

  3. Select + New. From the list of technologies, select Salesforce.

  4. 数据连接窗口中,选择数据源

  5. Select +New.

  6. Specify the connection name and the data source name. Select the Environment.

  7. In the Credentials section, select your authentication method, and enter the credential name. For more information, see Authentication Methods.

  8. 选择保存。您也可以在保存之前测试连接。

  9. 选择连接。Salesforce 可能会请求身份验证。

  10. 在文件浏览器窗口中选择要读取或写入的文件。

  11. 选项窗口中选择读取或写入配置。

  12. 选择确认以创建与该文件的连接。您可以继续构建您的工作流。

Input and Output Tools

The Salesforce Input and Output tools are used to read from and write to Salesforce.

Salesforce Input

Salesforce Input reads standard and custom objects. You can read in three ways:

  • Query Builder: Pick an object and select the fields you want to read. The field picker offers a multiselect list with Select All, search by string or substring, a live count of selected versus total fields, and a filter to show only what's selected. A record limit can also be set. Four field modes are available: Read all Standard Fields, Read all Custom Fields, Read all Fields, and Choose Manually.

  • Custom Query (SOQL): Write a SOQL query to read standard and custom objects, including __r relationship fields, then validate it before running. A custom query always returns a single table.

  • Read from Report: Browse and search saved reports, select one report, and parse its results.

Salesforce Output

Salesforce Output writes rows to a standard or custom object. Choose an action:

  • Insert: Add new records.

  • Update: Modify existing records. Requires the Salesforce record ID.

  • Delete: Remove records. Requires the Salesforce record ID.

  • Upsert: Insert new records and update existing ones in a single action.

Output processes records in batches and lets you choose the Salesforce API version. When you use Update, Delete, or Upsert, include the record ID as the primary key in your data.

Object Model

Salesforce stores data in objects, which behave like database tables:

  • Standard objects are built in, for example Account, Contact, Lead, Opportunity, Case, Campaign, Task, Event, and User.

  • Custom objects are created in your org and end with __c, for example Invoice__c.

  • Relationship fields between objects use the __r suffix and can be referenced in SOQL.

身份验证方法

Salesforce 支持…

Method

Required Fields

Desktop (Flagship)

Cloud (Alteryx One)

Built-in app (OAuth 2.0)

None

Yes

Not available (built-in connection creation is not offered on Cloud)

Custom app (OAuth 2.0)

Client ID, Client Secret, Redirect URI (default http://localhost:1717/), Scope (default api offline_access)

Yes

Yes

Salesforce Credentials (username, password, security token)

Username, Password, Security Token (optional), Client ID, Client Secret

Yes

Yes

Custom domain across all methods

NA

Yes

Not available (custom domain is not supported for all methods on Cloud)

 

OAuth supports both the Authorization Code flow (user to app) and the Client Credentials flow (service principal, for headless or scheduled automation).

Migration to Unified Connector

If you already use the Salesforce connector in Alteryx, read the section below. It walks through what has been changed in the unified version.

Parameter

Legacy Connector

Unified Connector (v6.1.0)

Platforms and Tools

Desktop (Input and Output)

Cloud (Input only)

Desktop (Input and Output)

Cloud (Input and Output, in progress)

Framework

Python SDK (Desktop)

CData ODBC driver (Cloud)

EACD framework (Desktop and Cloud)

Communication / API

Salesforce API v52 (Summer '21)

Salesforce API v61+ (Summer '24)

Auth methods

OAuth 2.0

Username + Password + Security Token

Same methods, with expanded configuration

Connection model

Separate Production / Sandbox / Custom URL choices

DCM, with a single Environment URL field

Key Changes

  • Production, Sandbox, and Custom URL dropdown options have been replaced by a single Environment URL field. Reconfigure any workflow that used this dropdown.

  • Environment URL replaces the old dropdown: https://login.salesforce.com (production, default), https://test.salesforce.com (sandbox), or your custom domain.

  • Salesforce Credentials authentication now also requires Client ID and Client Secret.

  • On Desktop, custom domains now work with all authentication methods (previously OAuth only).

Existing workflows can be migrated using the Alteryx Workflow Migration Utility in Designer 2025.2 Patch 3 or later. For more information, see workflow migration utility.

注意

  • The migration utility is available on Desktop only.

  • After installing the unified connector, you may see both the legacy and unified Salesforce technologies listed in Manage Connections. This is expected during the transition. Use the unified connector for any new work.

Limitations

  • The connector does not support a dry run for reads or custom queries. Run the workflow to retrieve data, or use the SOQL validation step to check a custom query before running.

  • For objects with more than 200 fields, the Read all Custom Fields and Read all Fields modes fail. Use Choose Manually to pick the fields you need, or write a SOQL Custom Query that lists specific fields.

  • A SOQL Custom Query always returns one table. To combine data from multiple objects, join them within the SOQL query, or use multiple Input tools and blend the results in the workflow.

  • Read from Report supports selecting a single Report per Input tool. To read multiple reports, use multiple input tools.

  • The connector uses the Salesforce REST API. The Salesforce Bulk API is not yet supported. For very large reads or writes, expect REST API throughput and Salesforce API limits to apply.

  • The object and field data preview is available on Cloud but not on Desktop. On Desktop, configure fields using the Query Builder field list or a SOQL query.

  • On Cloud, custom domain support across all authentication methods is not available. Use a supported method for your Cloud connection, or connect from Desktop where custom domain works with all methods.

  • The workflow migration utility runs on Desktop only.

  • On Cloud, the built-in app connection creation flow is not offered. Use a Custom OAuth app or Salesforce Credentials on Cloud.

  • The datatypes produced from the same object can differ between Cloud and Desktop.

  • On Cloud, loading a dataset can fail for some objects. If a specific object does not load, try a SOQL Custom Query for that object or reduce the selected fields.

  • The connector is generally available on Desktop. Cloud support is in progress and not yet generally available.

与 Designer 的兼容性(待讨论)

连接器发行版本 xxxx.x.x.xxxxx

ID

描述

JIRA-ID

  • Requires Designer 2025.1.2 Patch 7, 2025.2.1 Patch 5, 2026.1 Patch 2, or 2026.2 GA for all authentication methods.

  • Uses DCM and communicates via Salesforce API v61+ (Summer '24).

  • DCM-based connections with a simplified connection setup (a single Environment URL, and Custom OAuth that exposes Redirect URI and Scope).

  • Input:

    Query Builder: field Select All, search, count, filter, record limit.

    Read from Report with no record cap.

    SOQL Custom Query with validation.

    Choose API version.

  • Output

    Insert, Update, Delete, and new Upsert action.

    Batch processing

    Choose API version.

  • Fixed an issue where reading from a Salesforce report was limited to a fixed number of records (2000). This works only when using the standard REST API.

  • Fixed an issue where DateTime values were returned as 00:00:00, and empty values are now handled correctly.

  • Select All is now available on the column list.

  • Reusing an idle Custom OAuth DCM connection no longer fails with a token error.

  • Built-in app OAuth now authenticates correctly.

  • Dataset loading can fail for certain objects on Cloud.

  • Preview by schema is disabled for a Salesforce Custom Query.

连接类型

Alteryx 工具。最新版本可从 Alteryx Marketplace 获得。

支持类型

读取与写入

已验证版本

ODBC 客户端版本 2.2.20 也可用于输入和输出数据工具。

版本

描述

v5.1.4

  • 与 Designer 2021.4.2 补丁 6、2022.1 补丁 4 及更高版本兼容。

  • 仅与 AMP Engine 兼容。

  • 在 Alteryx Server 上运行此连接器需要 DCM。

  • Salesforce 连接器将时间和日期时间精度默认设为毫秒,以避免末尾出现多余的零,但若工作流有需求,仍支持纳秒级分辨率。(TPM-4753、TPM-4736)

  • 修复了 Salesforce 工具在 Server 上忽略代理设置的问题。(TPM-4647)

  • 修复了由于 Salesforce 工具依赖 Designer 的访问令牌,导致 Server 无法运行相关工作流的问题。(TPM-4846)

  • 修复了 Designer 开发工具在返回的 JSON 文件中暴露机密值的问题。(TPM-4788)

v5.1.3

  • 与 Designer 2021.4.2 补丁 6、2022.1 补丁 4 及更高版本兼容。

  • 仅与 AMP Engine 兼容。

  • 在 Alteryx Server 上运行此连接器需要 DCM。

  • 增加了使用 DCM 时对自定义 Salesforce 域的支持。

  • 改进了身份验证。

  • 已将 SDK 更新至 2.4.2 版。

  • 已将 API 更新为最新版本。

  • 修复了在使用 DCM 时 Salesforce 工具忽略 PAC 脚本的问题。(TPM-4620)

  • 修复了 Salesforce 输入工具无法读取某些日期类型列的问题。(TPM-4604)

  • 修复了 Salesforce 输出工具无法显示更新操作的字段映射的问题。(TPM-4519)

  • 修复了如果未在 DCM 中创建安全令牌,Salesforce 工具显示“访问被拒绝”的问题。(TPM-4507)

  • 修复了 Salesforce 工具未根据前端标签对齐 API 版本的问题。(TPM-4493)

  • 修复了 Salesforce 工具无法使用自定义域进行连接的问题。(TPM-4488)

  • 修复了 Salesforce 工具会针对时间戳意外截断发出警告的问题。(TPM-4368)

  • 修复了当在自定义 SOQL 查询中使用嵌套关系对象时,Salesforce 输入工具会将值截断的问题。(TPM-4367)

  • 修复了如果工作流包含多个 Salesforce 输出工具,Salesforce 输出工具会无限期运行的问题。(TPM-4268)

  • 修复了 Salesforce 工具将多个 API 版本显示为可选选项的问题。(TPM-4264)

  • 修复了 Salesforce 输出工具无法使用插入和更新操作写入数据的问题。(TPM-4248)

  • 修复了 Salesforce 工具无法正确读取百分比数据类型的问题。(TPM-4174)

  • 修复了 Salesforce 工具在处理自定义日期字段时返回错误的问题。(TPM-4051)

  • 修复了 Salesforce 工具返回“错误代码 400:请求语法错误或方法不受支持”的问题。(TPM-3982)

  • 修复了导致 Salesforce 工具运行缓慢的问题。(TPM-3919)

  • 修复了 Salesforce 输入工具将 VersionData 字段返回为 URL 而不是文档正文的问题。(TPM-3662)

已知问题

  • Salesforce 工具升级到新版本后,某些字段显示为 Null。(TPM-4805)

  • SDK 连接器忽略服务器上的代理 (Gallery)。(TPM-4647)

  • Designer HMTL 开发工具在返回的 JSON 中公开密钥值。(TPM-4788)

  • Salesforce 输入工具中的查询返回 Null 记录。(TPM-4641)

v5.1.2

  • 与 Designer 2021.4.2 补丁 6、2022.1 补丁 4 及更高版本兼容。

  • 仅与 AMP Engine 兼容。

  • 在 Alteryx Server 上运行此连接器需要 DCM。

  • 已更新为在 Designer 和 Server 2024.1 上运行。

  • 修复了 Salesforce 输入在运行 45 分钟后出现故障的问题。(TPM-3556)

  • 修复了缺少来源和描述元数据的问题。(TPM-3486)

  • 修复了 Salesforce 工具忽略代理设置的问题。(TPM-3358)

  • 修复了 Salesforce 输入工具返回“错误代码 401:无权限 - 请查看授权方案”错误的问题。(TDCE-449 和 TDCE-361)

v5.1.1

  • 与 Designer 2021.4.2 补丁 6、2022.1 补丁 4 及更高版本兼容。

  • 仅与 AMP Engine 兼容。

  • 在 Alteryx Server 上运行此连接器需要 DCM。

  • 已更新为在 Designer 和 Server 2024.1 上运行。

  • 修复了通过自定义 OAuth 应用程序进行身份验证不起作用的问题。(TFLN-1912)

  • 修复了 Salesforce 输入在配置为读取空数据集时无限期运行的问题。(TPM-2453)

已知问题

  • Salesforce 工具 5.1.1 无法在 Designer FIPS 和 Server FIPS 上运行。要解决此问题,请使用 5.1.0 版本。(TFLN-1982)

  • 工作流结果中当前缺少来源和描述元数据。(TPM-3486)

v5.1.0

  • 与 Designer 2021.4.2 补丁 6、2022.1 补丁 4 及更高版本兼容。

  • 仅与 AMP Engine 兼容。

  • 增加了对 DCM 至 Salesforce 输出的支持。

  • 在 Alteryx Server 上运行此连接器需要 DCM。

  • Salesforce 输出现在符合 FIPS 标准。

  • 提升了自动配置功能的性能。

  • 在 Salesforce 输入中添加了试运行选项。

  • 修复了 Salesforce 输入 5.0.10 错误解析数据类型的问题。(TFLN-1676)

v5.0.10

  • 与 Designer 2021.4.2 补丁 6、2022.1 补丁 4 及更高版本兼容。

  • 仅与 AMP Engine 兼容。

  • 增加了对 DCM 的支持。

    • 在 Alteryx Server 上运行此连接器需要 DCM。

  • FIPS 功能。

  • 添加了对 OAuth 身份验证和自定义域的支持。

  • 修复了 Salesforce 输入未显示所有字段和对象的问题。(TPM-1579)

  • 修复了 Salesforce 输入错误解析 PAC 文件的问题。(TFLN-1243)

  • 修复了当 Designer 语言设为法语时 Salesforce 输入不显示配置窗口的问题。(TDCE-119)

已知问题

  • 报告仅列出最近的报告,而不是列出所有可供用户使用的报告。

  • 报告仅返回前 2000 条记录。

v4.2.4

  • 修复了自定义查询无法通过 Salesforce 输入工具解析的缺陷。

  • 从命令行计划或运行 Salesforce 输入作业时,这些作业将不再失败。

  • 使用 Salesforce 输入工具中的证书验证来修复缺陷。

  • 支持在没有令牌的情况下,将 Salesforce 输入工具上传至 Gallery。

v4.1.0

  • 已添加对使用自动检测和配置通过代理进行连接的支持。

  • 与 Alteryx 2019.2 版本及更高版本兼容。

v4.0.0

  • 已添加查询 Salesforce 报告的功能。

  • 默认情况下,查询生成器和自定义查询返回所有记录(包括已删除的记录)。

  • 在 WHERE 子句中添加“IsDeleted=False”以排除已删除的记录。

  • 与 Alteryx 2018.3 - 2019.2 版本兼容。

v3.1

  • 修复了工作流配置的“运行时”选项卡下的“记录限制”和包含 XML 特殊字符的密码的缺陷。

  • 与 Alteryx 11.0 - 2018.2 版本兼容。

版本

描述

v1.3.1

  • 已更新工具元信息。

v1.3

  • 更新了宏指令引擎中的 Salesforce API 版本。

  • 修复了错误以正确转义字符。

v1.2

  • 日期时间字段会自动转换为 YYYY-MM-DDThh:mm:ss.sss。

  • 修复了即使用户尚未登录,仍会出现“需要表格名称”和“需要输出操作”错误消息的问题。

注意

  • Make sure you have the AMP engine enabled for the workflows which contain the Salesforce Input tool version 2.2.0 and later.

  • To setup a custom API application for this tool, see this guide.

  • If you want to process a PAC file that routes requests through multiple proxy IPs, use security tokens.

自定义 Salesforce 域

Salesforce 工具支持自定义 Salesforce 域。

要手动连接到自定义域...

  1. 在 Salesforce 工具配置窗口中,选择使用自定义环境 url

  2. 自定义环境中输入您的自定义域

使用 DCM 连接到自定义域...

  1. 选择设置连接。DCM 打开。

  2. 选择 + 新建。“新数据源”窗口打开,其中预先选择了 Salesforce 技术。

  3. 环境中选择自定义

  4. 自定义环境中输入您的自定义域