“读取 Salesforce 记录”任务

公告：Application Integration 现在可供您的 Google Cloud 项目使用。现在，您可以在同一 Google Cloud 项目中同时使用 Apigee Integration 和 Application Integration 了。了解详情

Apigee Integration 中有两种类型的任务：核心任务和连接器任务。读取 Salesforce 记录任务是连接器任务，可让您读取 Salesforce 实例中的现有 Salesforce 对象。

准备工作

本部分概述了连接和配置 Salesforce 实例以使用变更数据捕获 (CDC) 或平台事件以发布/订阅方式将变更流式传输到您的 Apigee Integration 所需的步骤。在 Apigee Integration 中配置任何与 Salesforce 相关的任务或触发器之前，必须完成以下步骤：

• 设置集成用户
• 配置权限集
• 设置安全令牌
• 创建关联的应用

注意：如需完成这些步骤，您需要具备对 Salesforce 实例的系统管理员权限。如果您没有管理员访问权限，请与您的 Salesforce 管理员共享这些说明。

本教程提供深入说明，但我们建议您对 Salesforce 配置选项有一定了解。Salesforce 提供详细的开发者文档，可帮助您上手使用。

设置集成用户

注意：如果您已有集成用户并且知道密码，则可以跳到下一步。如果您需要重置密码，请参阅下文中的第 6 步。

按照以下步骤设置集成用户：

1. 使用您的 sysadmin 凭据登录您的 Salesforce 实例。
2. 点击齿轮图标，然后选择 Setup，如下图所示：
3. 在 Administration 菜单中，点击 Users > Users。
4. 在 Users 窗格中，选择 New User 按钮。
5. 在 User Edit 对话框中，填写以下详细信息：
   1. First Name：集成用户的名字。
   2. Last Name：集成用户的姓氏。
   3. Email Address：集成用户的电子邮件地址。最好是群组电子邮件地址。
   4. Username：符合任何组织级命名规则的用户名。

      如果您要创建新的集成用户，请使用以下格式：EMAIL.SALESFORCE_ORG_NAME.SANDBOX_NAME

      如果您已有集成用户，请确认在此处输入的就是该用户名。

   5. Role：从选项下拉菜单中选择。
   6. User License：输入 Salesforce；如果使用试用组织，则输入 Salesforce Platform。
   7. Profile：从下拉菜单中选择集成用户的权限配置文件。

      我们建议不向配置文件分配任何权限，以防止集成用户 Salesforce 访问权限被未经授权地使用。

   8. 点击保存。
6. 如需更新新集成用户的密码，请按以下步骤操作：
   1. 点击 Users 窗格中的 Reset password(s)。系统会将一封重置密码电子邮件发送到与该用户关联的电子邮件地址。
      注意：在触发重置密码流程之前，请确认您可以访问与该集成用户关联的电子邮件账号。此外，如果您已为此用户启用了 SSO，则无法重置密码。要启用重置选项，请转到 Profile > System Permissions，然后取消选中 SSO Login Enabled 选项。
   2. 在电子邮件账号中按照重置密码流程操作。记下新密码，因为您将在后续步骤中用到它。

配置权限集

如果您已有适合集成用户的权限集，则可以跳过此步骤并转到设置安全令牌步骤。否则，请按照以下步骤为集成用户和 Salesforce 对象配置权限集。

如需为集成用户配置权限集，请执行以下操作：

1. 在 Setup 菜单中，点击 Users > Permission Sets。
2. 在 Permission Sets 窗格中，点击 New 按钮。
3. 在 Permission Sets 对话框中，输入以下详细信息：
   • Label：输入权限集的名称。
   • License：从 License 下拉菜单中选择 Salesforce。
   • 点击保存。
4. 在 System 设置选项列表中，向下滚动并选择 System Permissions。
5. 在 System Permissions 页面上，点击 Edit 按钮。
6. 向下滚动可用权限列表，并选中 API Enabled 复选框。

   Api Only User 权限也是必需的，但在所需的安全令牌重置之前无法启用该权限。此权限将在后续步骤中添加。

7. （可选）滚动并选中 Modify All Data 和 View All Data。这些权限不是必需的，但如果您希望自动向集成用户授予新对象的访问权限，则这些权限很有用。我们建议您仅在沙盒中启用这些权限用于测试。
8. 滚动到权限列表的顶部，然后点击 Save。
9. 确认设置，然后点击 Save。

要为 Salesforce 对象配置权限集，请执行以下操作：

1. 点击 Permission Set Overview 以返回主 Permissions Set 配置页面。
2. 在 Permissions Set 窗格的 Apps 部分，选择 Object Settings。
3. 向下滚动并选择需要权限集的 Salesforce 对象。本示例使用 Opportunity 对象。
   注意：CDC 仅支持一部分标准 Salesforce 对象。如需了解详情，请参阅更改事件对象支持。
4. 点击对象详情页面上的 Edit 按钮。
5. 选中记录类型的复选框。如果您知道哪些记录类型是必需的，请选择相应的记录类型。如果您不知道哪些记录类型是必需的，请选择所有记录类型。
6. 选中要启用的 Object Permissions 对应的复选框。建议选择 Read 和 View All。
7. 通过选中 Read Access 或 Edit Access 复选框，为每个对象字段授予相应的权限。
   注意：使用 CDC 时不需要写入权限。
8. 滚动到页面顶部，然后点击 Save。

设置安全令牌

如果您之前已经为集成用户创建了安全令牌并重置了密码，系统会自动发送包含新安全令牌的电子邮件。您可以使用新令牌并跳至创建关联的应用。

否则，请按照以下步骤重置集成用户的安全令牌：

1. 使用上一步中设置的用户名和密码，以集成用户的身份登录 Salesforce。
2. 在主菜单中点击配置文件图片，然后点击 Settings。
3. 在 Settings 菜单中，选择 Reset My Security Token 以打开 Reset Security Token 窗格。
4. 点击 Reset Security Token 按钮。
5. 查看与该集成用户关联的电子邮件账号，寻找包含新的安全令牌的电子邮件。记下新的安全令牌，因为您将在后续步骤中用到它。
6. （可选）为您的权限集启用 System Permissions 中的 Api User Only 权限，如上文的配置权限集步骤所述。

创建关联的应用

您必须拥有系统管理权限才能设置关联的应用。如果您目前以集成用户身份登录，请务必退出并以 sysadmin 身份重新登录。

按照以下步骤设置关联的应用：

1. 点击齿轮图标，然后选择 Setup。
2. 在 Setup 菜单中，搜索并选择 App Manager，如下图所示：
3. 点击 New Connected App。
4. 在配置窗格中，提供以下详细信息：
   • Connected App Name：输入关联的应用的名称。
   • API Name：输入 API 的名称。
   • Contact email：输入关联的应用的电子邮件地址，最好是群组电子邮件别名。
   • API (Enable OAuth Settings)：选择 Enable OAuth Settings。然后设置以下各项：
     1. （可选）Callback URL：仅当您希望外部服务执行验证时，才需要设置此项。如果您选择提供回调，请确保添加 http(s):// 前缀。
     2. Selected OAuth Scopes：选择：
        • Access and manage your data (api)
        • Perform requests on your behalf at any time (refresh_token, offline_access)
5. 点击保存。
   注意：新创建的关联应用在创建后的最初 2-10 分钟内将无法正常运行。
6. 点击继续。
7. 下一页上会显示使用方 Secret 和使用方密钥。请记下这些值，因为在设置 Apigee 的身份验证模块时会用到它们。
8. 点击管理按钮。
9. 进入 Connected App Detail 页面后，点击 Edit Policies 按钮。
10. 在 OAuth Policies 部分，将 Permitted Users 下拉菜单中的值更改为 Admin approved users are pre-authorized。
11. 点击保存。
12. 滚动到页面的 Profiles 和 Permission Sets 部分，选择要应用于关联应用的配置文件或权限集。
    您可以选择配置文件和/或权限集，这将允许拥有正确配置文件或权限集的用户访问关联的应用。
13. 选择所需的配置文件或权限集。
14. 点击保存。

身份验证

如需使用此任务，您必须使用 OAuth 2.0 客户端凭据设置身份验证配置文件。Apigee Integration 使用身份验证配置文件连接到 Salesforce 实例。如需创建身份验证配置文件，请执行以下步骤：

1. 在任务的可修改属性中，点击 + 新的身份验证配置文件以打开身份验证配置文件对话框。
2. 设置以下属性：
   • 在身份验证类型中，选择 OAuth 2.0 资源所有者密码凭据。
   • 令牌端点：
     • 对于沙盒，请输入 https://test.salesforce.com/services/oauth2/token
     • 对于生产环境，请输入 https://login.salesforce.com/services/oauth2/token
   • 客户端 ID：输入客户端的唯一标识符。

     客户端 ID 是所关联应用的使用方密钥。您可以在关联的应用的管理关联的应用页面或关联的应用定义中找到使用方密钥值。

   • 密钥：输入客户端密钥。

     客户端密文是所关联应用的使用方密文。您可以在关联的应用的管理关联的应用页面或关联应用的定义中找到使用方密文。

   • 范围：访问令牌的范围。

     您可以通过范围来指定用户的访问权限。您可以指定多个范围，以空格分隔。

   • 用户名：用于身份验证的用户名。
   • 密码：用户密码。
   • 请求类型：选择以下值之一：
     • 查询参数
     • 请求正文

     Salesforce 实例应支持您选择的请求类型。

   • 令牌参数：获取令牌所需的请求参数。
   • 身份验证配置文件名称：身份验证配置文件的名称。
   • 身份验证配置文件说明：身份验证配置文件的说明。
   • SSL 证书：上传 SSL/TLS 证书和相应的私钥。

     如果私钥具有密码，请输入密码。

3. 点击保存。

配置“读取 Salesforce 记录”任务

要配置读取 Salesforce 记录任务，请执行以下操作：

1. 转到 Apigee 界面并登录。
2. 使用界面左上角的下拉菜单选择您的组织。
3. 点击开发 > 集成。
4. 从集成列表中搜索或选择要修改的集成，然后点击以打开集成设计器。
5. 点击+添加任务/触发器 > 任务以查看可用任务的列表。
6. 将读取 Salesforce 记录元素拖动至集成设计器。
7. 点击设计器上的读取 Salesforce 记录元素，以查看读取 Salesforce 记录任务配置窗格。
8. 从身份验证下拉菜单中选择您之前创建的身份验证配置文件。
9. 使用任务的配置属性配置其余字段。
10. 系统会自动保存对属性的更改。

配置属性

下表介绍了读取 Salesforce 记录任务的配置属性。

属性	数据类型	说明
Salesforce 网域	字符串	您要连接的 Salesforce 实例的名称。 Salesforce 网域可在 Salesforce 实例网址中找到。例如 INSTANCE_NAME.my.salesforce.com。
Salesforce API 版本	字符串	Salesforce 实例中的当前 API 版本。 在 Salesforce 实例中，依次转到设置 > API > 生成合作伙伴 WSDL，可找到当前的 API 版本。
对象名称	字符串	您要读取的 Salesforce 对象的名称。
记录 ID	字符串	要更新的记录的 ID。 当您插入记录时，系统会自动创建 ID 值。ID 值可唯一标识记录，并且不会在记录的生命周期中发生变化。
记录	字符串	任务的返回值。 如果读取操作成功，则此变量包含读取的 Salesforce 对象的详细信息。

失败时重试

您可以配置各种重试策略来处理任务中的错误。借助重试策略，您可以指定如何在出现错误时重新运行任务。如需了解详情，请参阅错误处理策略。

注意事项

Salesforce 实例中的配额限制可能会影响此任务的使用。请与您的 Salesforce 管理员联系，确保您的集成设计符合 Salesforce 配额。