创建 HCM 电子表格数据加载 er 模板

简介

使用 HCM 电子表格数据加载程序 (HSDL) 为业务用户和入站集成提供批量数据加载功能。您可以为特定用例配置电子表格模板，并将对这些模板的访问权限仅分配给需要这些模板的角色。例如，招聘集成可以访问“新聘人员”电子表格，而“晋升”电子表格将可供人力资源专员使用。这两个模板都维护“员工”业务对象，但仅适用于规定的用例。

注意：

将 HSDL 用于集成的优势在于，您将数据限制为模板支持的特定用例。如果需要，还可以强制实施数据安全性。

目标

在本教程里，您将：

了解如何设计和配置 HSDL 模板。
创建可加载新雇用员工的工作模板。

Worker 业务对象很复杂，对象层次结构中大约有 30 个对象超过 5 个级别。本教程将介绍如何创建简单有效的新聘人员模板，同时说明用于定义电子表格模板的常见任务。然后，您可以将这些步骤应用于任何受支持的业务对象。

理解了模板创建的基础知识后，后续步骤部分列出了将扩展您的知识的教程。

先决条件

要完成本教程，您需要：

安装了 Desktop integration（桌面集成）的 Windows 计算机，用于测试模板。
对电子表格模板任务的访问权限，该任务具有为员工业务对象创建模板的分配访问权限。

按照配置对设计和维护 HCM 电子表格数据加载程序 (HSDL) 模板的访问权限教程中的任务 2 和 3 来创建此类角色。

注意：

本教程假定您已启用 Redwood。如果不是这样，请按照本教程的版本 25C 进行导航和屏幕截图。

教程任务

电子表格模板 Redwood 任务使用引导式流程来创建和维护模板。本教程中的任务是以引导过程中的步骤命名的。

任务 1：添加 - 输入模板信息

在此步骤中，您将基于员工业务对象层次结构创建新模板。

使用具有可访问员工业务对象的 HSDL 模板设计者角色的用户登录应用程序。
导航到我的客户组 > 数据交换 > 电子表格模板。
单击添加以启动引导流程。

提供名称，将业务对象设置为员工，并根据需要提供说明。

模板代码将根据模板名称自动生成。可以编辑此内容。

查看数据安全性。如果要应用数据安全性，上载数据为应设置为会话用户。

注意：
并非所有业务对象都支持使用会话用户加载数据。
您需要额外的功能安全权限才能为以提升用户身份加载数据的模板分配访问权限。
单击 Continue（继续）以转到 Select attributes（选择属性）步骤。

任务 2：选择属性

在此任务中，您将选择希望电子表格用户填充新聘人员的属性。

提示：

选择属性时，请重点关注用户需要在电子表格中输入或维护的值。您无需手动添加层次结构中的每个标识符或对象。

此表汇总了您可能要为简单“新聘人员”提供的属性。在以下步骤中，您将向模板添加这些属性以及新记录所需的这些对象上的属性：

对象	属性
Worker	Date of Birth
个人姓名	姓氏名字职位
人员法规数据	Gender 婚姻状况
分配	人员类型为工作关系的主要分配部门职务代码职位代码薪资级别代码

提示：

在引导流程流中继续执行下一步时，模板设计者将添加保留模板中记录之间的父子关系所需的任何对象。然后，您可以指定用于唯一标识每个对象的属性，模板设计者将自动添加任何标识属性，例如尚未保存到模板中的人员编号。

Worker

Worker 对象是层次结构中的顶层对象，用于标识单个员工。它包括人员的人员编号、出生日期和开始日期。

将 Object 筛选器设置为 Worker 。

单击必需筛选器，然后选择用于新记录。

提示：
请记住，将自动添加始终必需的属性。我们需要手动添加新记录所需的属性，因为模板设计器不知道您是创建新记录还是更新现有记录。
单击表上方的复选框以选择所有显示的属性。

单击操作代码属性标签上可用的链接。这将显示属性的详细信息。

提示：
有时属性名称可能不熟悉，或者可能存在多个名称相似的属性。在选择属性之前，可以使用属性详细信息面板查看属性。
清除 Required 筛选器并搜索 date of birth 。
检查 Date of Birth 属性。

搜索并选择人员编号属性。

注意：
由于人员编号属性唯一标识员工，因此如果您不这样做，模板设计者将自动添加此属性。现在添加它不会阻止模板设计器自动选择其他必需属性。

个人姓名

人员姓名对象记录员工姓名。

更改 Object 筛选器以显示“Person Name（人员姓名）”属性。

单击必需筛选器，然后选择用于新记录。

提示：
不要忘记删除搜索面板中的任何搜索标准。
选择显示的所有属性。
清除 Required 过滤器。
搜索并选择名字属性。
在模板中添加您想要的任何其他可选人员姓名属性，例如职务。

人员法规数据

人员法规数据对象获取员工的婚姻状况和性别。

将对象筛选器更改为人员法规数据。
将属性列表筛选为对于新记录所需的属性列表。

提示：

人员法规数据对象上的新记录不需要任何属性。

清除必需筛选器，搜索这些可选属性并将其添加到模板：

Gender
婚姻状况

查看其他可用人员法规数据属性，并根据需要添加到模板。

分配

分配对象用于指定员工的部门、地点、职位、职务等。

为分配对象添加对于新记录所需的所有属性。
清除 Required 过滤器。
搜索并添加模板中所需的其他属性。以下是几点建议:

人员类型
工作关系的主要分配
Department
职务代码
职位代码
薪资级别代码

单击继续。

提示：

如果您在层次结构中的多个对象中选择了属性，可能需要一些时间才能进入下一步。模板设计器正在验证您从中选择属性的对象，并添加确保每个记录具有完整的层次结构所需的任何对象。

任务 3：选择记录标识符

在此任务中，您将查看用于唯一标识模板中包含的每个记录的属性。HSDL 支持用户关键字和代理 ID。

查看模板中包括的对象列表。

提示：
虽然您未从工作关系或雇用条款对象添加属性，但模板设计者了解，这些对象的记录需要将分配记录链接到员工记录。
单击编辑。

注意：

模板设计器自动将模板配置为使用用户关键字，因为这些是业务用户用于在应用程序中查看的属性。

提示：

当一个对象提供多个用户关键字时，“用户关键字”字段将变成一个选项列表，您可以查看并选择您的用例所需的用户关键字。

将属性类型字段更改为代理关键字。

提示：

您可能希望为用于维护现有记录的模板选择代理关键字。代理关键字属性提供可搜索的值列表。

请注意，对用于标识模板中每个对象的属性所做的更改。

如果您使用代理关键字来标识记录，则这样做只是为了观察行为并查看模板中将包括的属性。

单击取消。由于此模板是上载新记录，因此我们将使用用户关键字。代理关键字仅可用于参考现有记录。
单击继续。
配置属性步骤显示保存到模板的所有属性。

注意：

用于标识每个记录并形成记录之间的父子关系的属性会自动添加到模板中。由于 Worker 是日期有效的对象，因此也会自动添加有效开始日期。

单击 Show Hidden Attributes（显示隐藏的属性）筛选器并向下滚动。

现在，您可以看到，映射到父对象上属性的子对象上的属性已自动添加、默认和隐藏在电子表格中。

任务 4：测试

您应定期测试模板，生成电子表格并查看其执行方式，以及哪些更改会简化使用并减少数据错误。

虽然仅提到此任务一次，但应在剩余步骤中重复执行此任务。

保存任何最近的更改。
单击信息标题中的生成电子表格。

提示：
此信息横幅可用于引导流程的其余步骤。
打开下载的 xlsx 文件，并在提示登录时单击 Yes 。
使用您的应用程序用户名和密码登录。将使用配置为在电子表格中显示的每个选定属性生成电子表格。
单击电子表格加载程序工具栏上的创建数据集。

提示：

如果您只想查看列标题、提示、默认值和值列表，则无需创建数据集即可执行此操作。您只需要数据集即可测试使用电子表格上载数据。

在对话框页面上单击 OK 。

使用预定义名称创建数据集；如果需要，您可以改写此设置。

双击列标题下第一行中的任何单元格以启动该行。

提示：

任何不带值的必需单元格都将突出显示红色大纲。配置有缺省常量值的任何属性都将显示缺省值。

双击标题在列标题后包含 [..] 符号的单元格。这将打开可搜索的值列表。
为电子表格行中的每个空单元格输入有效数据。

提示：

使用应用程序中的新人员任务可确定属性的有效值。

要测试电子表格是否加载有效数据，请单击电子表格加载程序工具栏上的更多 > 上载。

在显示的任何对话框页面上单击确定。
定期单击刷新以刷新电子表格行状态。

上载进度将更改状态，直到处理完成且状态为“成功”或“错误”。

如果获得错误状态，请查看错误消息，并根据需要进行更正。单击上载以重新提交数据集中的更正的电子表格行。

定位至人员管理任务以确保可以看到您的新聘用。

提示：

在应用程序中看到您的员工可能会有短暂的延迟。

任务 5：配置属性

在此任务中，您将学习如何配置模板属性的默认值、隐藏不希望用户更新的属性、配置自动生成的人员编号以及更改列标题和提示。

配置属性将简化用户的数据输入，并可以限制最终用户可以执行的操作。例如，您可以将操作代码默认为“聘用”，并从电子表格中隐藏此属性。然后，从此模板生成的电子表格只能执行 HIRE 操作。

默认值

您将在本教程中配置三种类型的默认值：

常数
其他选定属性
表达式

其他类型可用，具体取决于默认属性的数据类型。

配置常量默认值

将这些属性配置为将其值默认为常量值。

单击操作代码属性列标题上的链接。

使用编辑面板复查属性的配置以及可以更新的字段。

属性的默认值预配置为 None 。

将 Attribute Default（属性默认值）更改为 Constant value（常数值）。此时将显示常数值字段。

指定 HIRE 值，然后单击 Save 。

编辑这些其他属性以为其配置常量值默认值：

属性	对象	常数值
名称类型	人员名称	GLOBAL
有效序号	雇用条款	1
最近有效更改	雇用条款	是
分配状态类型	雇用条款	ACTIVE_PROCESS

注意：

为查找已验证属性指定默认值时，需要指定查找代码，而不是含义。

使用 Configure attributes（配置属性）表中的 Default（默认）列检查配置的默认值。

配置其他属性值的默认值

您可以将属性配置为从模板中选定的其他属性中默认其值。

提示：

将电子表格数据上载到分段表时会复制属性值，模板的电子表格中看不到该值。从其他选定属性默认属性值时，始终隐藏默认属性。

编辑员工对象上的有效开始日期属性。

选择“Effective Start Date（有效开始日期）”属性，然后单击“Edit（编辑）”

注意：

创建新聘用时，员工记录的有效开始日期必须与员工的开始日期相同。

将默认指定为现有选定属性。

使用“属性关键字”字段上的可搜索值列表从 Worker 对象中选择“开始日期”属性。

提示：

值列表使用属性关键字唯一标识模板中的每个属性。您可以在“配置属性”表的属性关键字列中找到每个属性的属性关键字。

取消选中显示复选框以从电子表格中隐藏属性。

单击保存。

注意：

模板设计器自动将子级对象上父子关系和日期有效字段的用户关键字属性默认至父级的属性值，因此无需手动执行此操作。

编辑工作关系、雇用条款和分配对象上的操作代码，以默认员工对象上的操作代码中的值，并从电子表格中隐藏属性。

单击保存。

由于这些属性已隐藏，它们将从“配置属性”表中消失。

搜索 " action " 并单击 Show Hidden Attributes 过滤器以显示 "Action Code" 属性的所有匹配项。
编辑这些属性以配置现有选定属性中的默认值，并取消选中显示复选框：

属性	对象	现有的选定属性
开始日期	工作关系	员工开始日期
法规代码	人员法规数据	人员姓名 - 法规代码
分配状态类型	分配	工作地区 _ 分配状态类型代码

保存所做更改。

使用表达式配置默认值

可以使用 groovy 表达式定义属性的默认值。通过指定唯一标识模板中属性的属性关键字，这些关键字可以包括对其他选定属性的引用。

查找“人员编号”属性的属性关键字。

提示：

属性关键字通常是对象名称 (Worker)，后跟基本属性名称 (PersonNumber)。

编辑雇用条款对象上的分配编号属性。
指定使用表达式的默认值，并指定 "ET" + Worker_PersonNumber 的 Groovy 表达式。

单击保存。
使用表达式 "E" + Worker_PersonNumber 为 Assignment 对象上的 Assignment Number 属性配置表达式默认值。

保存您的更改。

提示：

建议在成功测试常量值或表达式后，不要隐藏默认属性。

考虑为其他属性配置默认值以简化数据录入，例如法规代码、员工类型、业务单位和合法雇主。如果需要，您可以隐藏这些内容或将其留给最终用户进行覆盖。

自动生成的人员编号

仅当要自动生成人员编号时才完成此步骤。

编辑员工对象上的人员编号属性。
选中 Autogenerate（自动生成）复选框。

注意：

虽然成功上载员工时将生成人员编号，但电子表格的用户仍必须提供值以唯一地区分电子表格中的每个员工。提供的值将替换为自动生成的值。

单击保存。
编辑雇用条款对象上的分配编号属性，并勾选自动生成复选框。

取消选中显示复选框以从此模板生成的电子表格中隐藏分配编号。

提示：

请勿删除在上一个任务中配置的分配编号默认值。这将使用基于人员编号的值填充这些属性。

编辑分配对象上的分配编号，以自动生成其值并将其隐藏在电子表格中。
保存所做更改。

隐藏栏位

成功测试常量和表达式默认值后，隐藏不希望用户更改的默认属性。

编辑属性以隐藏生成的电子表格。
取消选中显示复选框。

单击保存。
对您不希望用户更改的其他默认属性重复此操作，例如“操作代码”、“生效序号”、“生效的最新更改”和“分配状态类型”。

提示：

您可以通过查看“配置属性”表中的默认列来轻松标识配置了默认值的属性。

必需的属性

在此步骤中，您将根据需要编辑要在电子表格中突出显示的属性。

编辑 First Name（名字）属性并选中 Required（必需）复选框。

单击保存。
对于默认情况下不需要用户提供的任何其他属性，重复此操作。

列标题和提示

更改列标题和提示，以使用您的业务用户会理解的术语。例如，如果要自动生成人员编号，则可能需要重命名人员编号列标题和提示。

编辑人员编号属性。
将列标题更改为行标识符，以便在创建具有不同人员编号的人员时不会混淆用户。
将列提示更改为数字，以唯一标识电子表格中的行。

提示：

将鼠标悬停在电子表格中的列标题上时，将显示提示。

单击保存。

对列重新排序

列在表中的显示顺序决定了这些列在电子表格中的显示顺序。

选择要移动的属性，以避免单击“列标题”上的链接。将属性行拖放到新位置。

提示：

在尝试对列重新排序之前，您需要删除所有筛选器并保存所做的更改。

最佳实践

考虑以下事项：

明确指定要提供的值的类型。
如果属性需要代码，则在列标题中包括“代码”。例如，“国家/地区代码”，而不是“国家/地区”。为了进一步澄清，您可以定义最常见值的默认值，以便用户知道要提供数据的格式。
在可能的情况下配置值列表。
考虑列的顺序。
如果定义了从属值列表，请确保在具有引用值列表的属性之前输入列表所依赖的值。

任务 6：改写参数

您可以通过改写参数默认值来改写默认电子表格数据加载行为。在此部分中，如果超过 10% 的电子表格行出错，您将确保数据加载停止，并且您将为增量更新启用加载事件。

导航到覆盖参数步骤，方法是单击引导式流程栏中的步骤，或者单击配置属性步骤中的继续按钮。

单击 Add Parameters 。此时将打开模板参数抽屉。

选择最大加载错误百分比参数，然后单击添加。

选择“Maximum Percentage of Load Errors（最大加载错误百分比）”并单击“OK（确定）”

单击编辑操作，并将值更新为 10 。
添加 Enable Load Events for Incremental Updates 参数并将其值更新为 Yes 。

单击继续。

任务 7：添加说明

（可选）向电子表格添加说明，以便向用户提供有关如何使用此模板生成的电子表格方面的指导。

单击添加。

指定标题和说明。

单击添加。

提示：
如果有多个指令，请通过向上或向下拖动指令行来更改这些指令的显示顺序。
单击继续。

任务 8：配置访问

在激活 HSDL 模板之前，有两种类型的角色访问权限：

数据集操作
要使业务用户能够使用此模板，必须为其角色分配对模板的数据集访问权限，并且必须激活模板。
模板维护
激活后，您将不再有权自动维护模板。您应配置哪个角色有权在模板处于活动状态后维护模板。

数据集运算

配置可从此模板生成电子表格的角色及其具有的数据集访问权限。

注意：

数据安全性部分指明上载电子表格数据的用户类型。如果此项设置为 Elevated user ，则可能会限制您为任何角色分配数据集操作。将角色分配给模板字段将确认是否可以。

单击数据集操作标题下的添加。

单击“Data set operations（数据集操作数）”标题下的“add（添加）”

搜索并选择要为其分配模板访问权限的角色，例如人力资源专员。

单击添加。

默认情况下，将为角色分配创建、保存和上载数据集的访问权限。

根据需要更改数据集访问权限。

数据集操作
操作	说明
创建	可以创建数据集。
保存	数据集数据可以保存到中转表中。
上传	可以上载数据集，并将有效行保存到应用程序。
回退	可以回退数据集，删除已成功加载但随后未更新的数据。回滚仅对几个业务对象可用。
查看全部	可以下载和复查模板的所有现有数据集，而不仅仅是用户创建的数据集。

提示：

您可能拥有一个模板，您需要一个角色才能创建数据并将其保存到分段表，但无权上载该数据；另一个角色无法创建新数据集，但可以复核其他用户创建的数据集并上载这些数据集。这可以实现一种审批形式。

模板管理

模板处于活动状态后，您只能在您的角色配置为维护模板时维护模板。

以下步骤介绍了如何分配模板维护。

单击模板维护标题下的添加。

搜索模板设计器或维护角色，例如 HSDL 模板设计器，并添加可以维护此模板的角色。

单击添加。

任务 9：复查并启用

只有活动模板在运行电子表格数据加载程序任务中可见，并且对 REST 服务可用。对于状态为草稿的模板，请完成这些步骤。

在复查并激活步骤中，您可以查看将在从模板生成的电子表格中看到的列列表以及这些列的显示顺序。您还可以复核属于模板定义但未显示在电子表格中的属性。

检查

查看电子表格属性列表，检查列标题和小费中的拼写错误，并确认验证类型、必需状态、默认值和列顺序正确。

单击隐藏属性选项卡可查看模板定义中但不显示在电子表格中的属性。

验证并激活

单击验证。

如果模板有效，您将看到一个对话框，询问是否要激活模板？

注意：

如果模板有警告或错误，您可以在“验证消息”选项卡上查看这些警告或错误。

单击激活。
现在，您的模板在运行电子表格数据加载程序任务中可供具有配置了模板数据集访问权限的角色的用户使用，并且 REST 可以在提供 csv 文件进行上载时使用。

测试业务用户访问

现在，您应该以具有分配给模板访问权限的角色的用户身份登录，并确认模板在运行电子表格数据加载程序任务中可用，并且模板生成的电子表格可以根据需要工作。

任务 10：导出和导入

在此任务中，您将导出模板定义，并了解如何将模板导入生产环境。

您需要在生产上具有 HSDL 模板维护角色，该角色配置为导入模板所基于的业务对象的模板。有关创建此类角色的步骤，请参阅配置对设计和维护 HCM 电子表格数据加载程序 (HSDL) 模板的访问权限教程。

导出

完全测试模板并准备将其移至生产环境时，您可以导出模板定义。

使用您的 HSDL 模板设计器角色登录到应用程序并导航到电子表格模板任务。
搜索模板。
单击操作按钮，然后选择导出操作。

模板定义将导出为 XML 文件，并且应该在“下载”目录中可用。

导入

导航到 Data Exchange 中的 Spreadsheet Templates（电子表格模板）任务。
单击导入。

在导入电子表格模板面板上，指定用于描述电子表格模板支持的用例的名称，例如新聘人员。
如果模板特定于法规，请指定其适用的法规数据组。
选择要导入的模板的 XML 定义文件。
提供说明，以便业务用户可以了解何时使用此模板。

提示：

代码将根据指定的名称进行默认设置，但您可以覆盖此名称。它必须是独一无二的。

单击导入。
您将返回到 Spreadsheet Templates（电子表格模板）页面，其中页级横幅将确认模板是否已成功导入或是否发现问题。

提示：

如果遇到错误，请下载日志文件以了解更多信息。

搜索导入的模板，然后单击模板名称以编辑模板。
重复任务 8 中的步骤以配置访问权限并分配模板维护角色。
按照 Task 9 中的模板验证和激活步骤操作。
具有已分配角色的用户现在可以在运行电子表格数据加载程序任务中访问您的模板。

后续步骤

以下教程将进一步扩展您的 HCM 电子表格数据加载程序知识：

致谢

作者 — Ema Johnson（HCM 数据加载程序和 AI 首席产品经理）

简介

目标