> 持续流程改进 > Hire to Retire 员工生命周期 > UKG Pro > 数据模板

数据模板：招聘到退休—员工生命周期

UKG Pro

← 返回改进指南

Hire to Retire - 员工生命周期属性 (22) Hire to Retire - 员工生命周期活动 (15) 提取指南 (1)

您的从招聘到退休——员工全生命周期数据模板

该模板概述了高效分析“从招聘到退休”流程所需的关键数据要素，明确应采集的核心属性、需要跟踪的关键活动，并提供从 UKG Pro 抽取这些数据的实用指南。借助此资源，可简化数据准备，为流程挖掘项目顺利起步打好基础。

建议收集的属性
需要追踪的关键活动
UKG Pro数据提取指南

不熟悉事件日志？了解如何创建流程挖掘事件日志.

下载模板

Hire to Retire - 员工生命周期属性

为全面开展“从招聘到离职（员工生命周期）”分析并获取洞察，建议在事件日志中包含以下数据字段。

5 必填 7 推荐 10 可选

	名称	描述
	事件timestamp EventTimestamp	某个生命周期事件发生的精确日期与时间。
描述事件时间戳为每个活动提供时间序列上下文，是流程流转的“骨架”。它记录诸如“Offer Accepted”或“Promotion Approved”等事件在系统中的登记时间。在分析中，这些时间戳用于计算活动间的时长、识别延迟，并衡量招聘、入职等关键子流程的周期时长。准确的时间戳是所有基于时间的KPI和绩效分析的基础。为何重要此属性用于按时间顺序排序事件，并计算所有基于时间的指标，如周期与持续时间。获取方式来自 UKG Pro 与特定事件关联的日期或时间戳字段，例如 'HireDate'、'TerminationDate'，或工作流模块中的状态变更时间戳。示例 2023-01-15T09:00:00Z2023-06-20T14:35:10Z2024-02-01T11:00:00Z
	员工ID EmployeeId	分配给每位员工的唯一标识，用作其在组织内整个生命周期的主case ID。
描述 Employee ID是贯穿员工全生命周期事件的主线，从初次申请到最终离职均以此关联。该标识符对于构建个人的端到端完整视图至关重要。在流程挖掘分析中，每个活动（如“Employee Hired”“Promotion Approved”或“Termination Initiated”）都会关联到这个唯一ID，从而支持个体路径分析、基于员工属性的同群分析，以及对生命周期时长的精确计算。为何重要这是将所有与员工相关的事件串联起来的关键案例标识符，使得可以对每位员工的端到端“从招聘到退休”流程进行分析。获取方式这是 UKG Pro 的核心字段，通常位于员工档案或主数据记录中。具体的表和字段名称请参阅 UKG Pro 文档，通常标注为 Employee Number 或 Person ID。示例 10052198345210047
	最后数据更新 LastDataUpdate	指示该事件数据最近一次从源系统刷新或提取的时间戳。
描述此属性记录上次从 UKG Pro 抽取数据的时间戳。它不是业务事件发生的时间，而是记录被导入流程挖掘工具的时间。该信息对于判断所分析数据的新鲜度至关重要，能帮助分析师和业务用户了解流程视图的时效性，并用于管理数据刷新计划与验证洞察的新近性。为何重要表示数据的新鲜度，这对于信任分析结果并及时做出业务决策至关重要。获取方式该时间戳会在数据抽取、转换与加载（ETL）过程中生成并附加到每条记录。示例 2024-03-15T02:00:00Z2024-03-16T02:00:00Z2024-03-17T02:00:00Z
	活动名称 ActivityName	员工生命周期中发生的具体事件或里程碑名称，例如“Employee Hired”或“Performance Review Conducted”。
描述 “活动名称”用于描述从招聘到离职（Hire to Retire）流程中的单个步骤或任务。系统会为每个事件打上时间戳并按发生顺序排列，由此构建出可在流程挖掘中可视化和分析的流程流转。通过分析这些活动的顺序和频次，可以还原真实的执行路径，识别常见路径、偏离标准流程的情况，以及在“Onboarding Initiated”和“Payroll Setup Completed”等关键活动之间的瓶颈。为何重要此属性用于定义流程图中的步骤，以便可视化并分析员工生命周期流程。获取方式通常来源于事件日志、工作流状态变更，或 UKG Pro 各模块（如 Recruiting、Onboarding、Performance Management）中的特定日期字段。通常需要映射逻辑来生成标准化的活动名称。示例员工已录用已进行绩效评审离职流程发起
	源系统 SourceSystem	用于标识数据提取自哪个系统，此处为UKG Pro。
描述此属性用于标识流程数据来源。在本场景中主要为 UKG Pro，但“从招聘到离职”流程也可能涉及候选人跟踪系统（ATS）或学习管理系统（LMS）等其他系统的数据。在分析中，涉及多个系统时，它有助于区分数据来源，并对数据治理与故障排查至关重要；对于单一来源视图，它提供必要的数据溯源背景。为何重要通过明确事件数据的来源，为数据治理、质量保证与可追溯性提供关键上下文。获取方式这通常是在数据转换与抽取过程中添加的静态值（“UKG Pro”）。示例 UKG ProUKGPro_CoreHRUKG
	执行人 ActioningUser	在 UKG Pro 中执行该活动的用户姓名或ID，通常为HR或经理。
描述此属性标识执行具体流程步骤的责任人，例如发出 Offer 的招聘人员或批准晋升的经理，用于将流程活动关联到实际参与者。在分析中，该属性有助于洞察工作量分布、识别培训需求并评估用户层面的绩效。例如，它可定位“薪酬设置完成”后出现的数据录入错误是否集中在特定用户，从而支撑“入职后数据返工率”KPI。为何重要将流程活动关联到具体用户，便于分析工作量、对比绩效，并定位返工或错误的根本原因。获取方式通常可在 UKG Pro 各模块的审计追踪日志或“Last Modified By”字段中找到，具体字段名称因模块而异。示例 j.does.smithhr_admin
	招聘需求ID JobRequisitionId	启动招聘流程的招聘需求唯一标识。
描述招聘需求ID是针对某一岗位空缺的唯一标识，关联从需求创建、审批到寻源、发放Offer等早期招聘活动。该ID是分析“招聘周期”KPI的基础，因为它标记了招聘流程的真正起点。借此可跟踪单个职位的全流程漏斗，并通过识别未推进的需求来分析“招聘需求停滞率”等指标。为何重要为招聘流程提供明确起点，可精确衡量招聘周期与需求单的有效性。获取方式位于UKG Pro Recruiting模块，或已连接的候选人跟踪系统（ATS）。示例 REQ-2023-015REQ-2024-112REQ-2023-504
	经理姓名 ManagerName	员工直属经理或主管的姓名。
描述此属性用于标识员工的直接经理。经理在绩效评估、晋升、培训分配等生命周期事件中至关重要。按经理维度分析有助于了解团队层面的执行差异与管理效能。例如，“经理变更影响分析”仪表板依赖该属性评估经理变动对后续活动的影响；它也是“经理重新介入所需时间”KPI 的关键。为何重要支持按团队维度分析流程绩效，并评估经理对员工生命周期事件的影响。获取方式该信息属于 UKG Pro Core HR 模块中的员工汇报关系数据。示例约翰·史密斯Maria Garcia陈伟
	职位名称 JobTitle	员工的官方职位名称，例如“软件工程师”或“销售经理”。
描述职位名称描述员工在组织中的角色或岗位。该属性是分析不同角色与资历层级间流程差异的关键维度。在分析中，可基于职位名称比较不同岗位的入职用时、评估晋升速度，或识别某些岗位是否存在更高的早期流失率，从而有针对性地优化HR流程与支持计划。为何重要支持按角色进行分析，了解不同职能与资历层级的生命周期流程差异。获取方式这是与员工岗位或职务记录相关的标准字段，位于 UKG Pro 的 Core HR 模块中。示例软件工程师 II高级产品经理HR业务伙伴
	部门 EmployeeDepartment	员工所在的部门或组织单元。
描述此属性为员工所属部门名称，例如“销售”“工程”或“财务”，是细分和对比流程绩效的重要组织维度。基于部门的分析可比较不同业务单元的流程执行。例如，可评估技术部门的“招聘周期”是否更长，或“绩效评审遵从度”在销售与运营之间是否存在显著差异，从而提供有针对性的改进依据。为何重要可基于组织架构进行筛选与分段，实现强有力的对比分析，揭示各部门的流程差异。获取方式这是 UKG Pro 的 Core HR 模块中员工岗位或职位记录里的标准字段。示例工程部销售人力资源
	雇佣状态 EmploymentStatus	员工当前或历史的雇佣状态，例如“在职”“已离职”或“休假”。
描述此属性表示员工在某一时间点在公司内的雇佣状态，是理解员工队伍整体状况并筛选特定人群进行分析的关键维度。跟踪雇佣状态变化有助于正确建模流程，例如区分临时休假与永久离职。它也是计算流失率并理解不同生命周期路径结果的基础。为何重要提供员工在职状态的核心信息，支持精确的流失分析与人群分层。获取方式这是 UKG Pro 的 Core HR 模块中员工主数据记录的核心字段。示例在职已终止长期休假
	雇用日期 HireDate	员工与组织建立雇佣关系的正式开始日期。
描述入职日期标志着员工任职期的开始，是众多基于时间的生命周期分析与计算的基准字段。该属性用于计算任职时长，是分析“早期离职率”的关键输入，也可用于同群分析，用于比较不同时期入职员工的生命周期特征。为何重要作为计算员工任职年限的基准，是开展队列分析与流失率指标的必备信息。获取方式这是 UKG Pro 的 Core HR 模块中员工主记录里的标准必填字段。示例 2022-08-152023-01-202021-05-10
	事件结束时间 EventEndTime	用于标记具有可度量持续时长的活动完成时刻的时间戳。
描述对于非瞬时的活动，Event End Time记录活动完成的时间；相对地，Event Timestamp (StartTime)标记活动开始。同时有开始和结束时间，便可精确计算单个活动的处理时长，例如“Background Check”或“Onboarding Task”。这有助于更细粒度地分析流程中的耗时分布。为何重要可精确计算单项活动的处理时长，帮助定位流程中最耗时的步骤。获取方式来自 UKG Pro 的完成日期字段。通常需要将开始事件与源数据中的对应完成事件进行配对。示例 2023-01-15T17:30:00Z2023-06-21T10:00:00Z2024-02-01T11:05:00Z
	地点 Location	员工所在的地理位置或办公地点。
描述此属性指员工的主要工作地点，可为城市、国家或具体办公楼，是开展 HR 流程的地域分析的关键维度。按地点分析流程绩效可揭示招聘效率、入职实践或离职率的区域差异。例如，可比较“纽约”和“伦敦”办公室的“招聘周期”，以识别最佳实践或本地化瓶颈。为何重要支持按地域切分流程，揭示不同地区在绩效与合规上的差异。获取方式该信息属于 UKG Pro Core HR 模块中员工职位或个人信息的一部分。示例美国纽约英国伦敦远程
	培训名称 TrainingName	分配给员工的培训课程名称或标题。
描述此属性标识分配给员工的具体培训或学习模块，范围可从合规必修课到岗位技能培训。这是“培训分配与完成”仪表板及“培训完成率”KPI 的关键属性，用于跟踪特定培训项目的进度与效果，并比较不同课程的完成时长。为何重要可跟踪并分析特定培训项目，用于衡量合规性与培养成效。获取方式来自 UKG Pro Learning 模块或已连接的学习管理系统（LMS）。示例 2024年行为准则高级管理技能网络安全意识
	处理时间 ProcessingTime	单个活动从开始到结束的持续时长（计算值）。
描述 Processing Time 用于衡量某个具体任务的耗时，计算方式为事件结束时间与事件时间戳（开始时间）之间的差值。它代表某项活动的“服务时长”。该指标有助于找出流程中最耗时的具体活动。例如，分析可能显示“背景调查已启动”这一活动平均需要5天完成，从而成为优先优化的对象。为何重要量化单个任务的耗时，便于对最耗时的活动进行针对性优化。获取方式此属性在数据准备阶段计算：用事件结束时间减去事件时间戳。示例 28800086400604800
	是否早期流失 IsEarlyChurn	一个布尔值标记，用于判断员工的离职是否发生在预先设定的在职早期时段（如90天或180天）内。
描述此计算属性用于标记入职后不久即离职的员工。“早期”的阈值通常由业务定义，例如首年内。该标记可简化“早期任期流失洞察”仪表板与“早期员工流失率”KPI 的分析，便于快速筛选与细分这一重点人群，分析其特征与生命周期路径，帮助识别招聘或入职环节的问题。为何重要直接支持早期流失分析，标记高风险员工，帮助识别员工过早离职的根因。获取方式此属性在数据准备阶段计算：比较“TerminationDate”与“HireDate”的差值是否满足预设阈值（如365天）。示例 truefalse
	离职原因 TerminationReason	记录在案的离职原因，例如“主动（辞职）”或“非自愿（绩效）”。
描述此属性记录员工终止雇佣关系的原因，通常分为自愿与非自愿，并包含更细的子类。这是留任与流失分析中的核心属性。按离职原因对已离职员工分组，可深入洞察流失根因。例如，按终止原因分析“早期员工流失率”，能区分招聘匹配不佳与外部竞争性报价等因素。为何重要提供员工流失驱动因素的关键洞察，支撑制定有针对性的留才策略。获取方式该字段通常在 UKG Pro 的 Core HR 模块的终止（Termination）或离职办理过程中记录。示例自愿离职—其他机会非自愿-绩效退休
	终止日期 TerminationDate	员工雇佣关系的正式结束日期。
描述离职日期标志着员工任职期的终点，是员工在组织内生命周期的结束节点。该属性用于计算员工最终任职期，也是流失分析的关键组成部分。入职日期与离职日期之间的时间跨度，是“早期任职流失洞察”仪表板及相关KPI的基础。为何重要定义员工生命周期的结束点，可计算总任职时长，并支持所有与流失相关的分析。获取方式这是 UKG Pro 员工主记录中的标准字段，在终止流程完成后写入。示例 2023-11-302024-02-152022-12-31
	绩效评分 PerformanceRating	在绩效评审周期内给员工的绩效评级。
描述绩效评级是“Performance Review Conducted”活动的结果，通常采用分值（如1-5）或描述性标签（如“Exceeds Expectations”）来量化员工的绩效评估。该属性可用于关联流程事件与绩效结果。例如，可分析高绩效员工是否晋升更快，或绩效评级与员工流失之间是否相关。它也是“绩效评审周期合规性”仪表板的核心指标。为何重要将流程事件与绩效结果关联，支持评估人才管理成效及其对留任率的影响。获取方式位于UKG Pro Performance Management模块，并关联到具体的评审周期。示例超出预期符合期望有待改进5
	薪级 SalaryGrade	对应员工岗位的薪酬等级或薪级带。
描述薪级用于表示某一岗位的薪酬等级，是分析薪酬相关活动与趋势的关键属性。该属性适用于“薪酬已变更”等分析场景；若频繁出现薪级更正，还可用于跟踪“入职后数据返工率”指标。同时，可据此进行分层，观察不同薪酬等级的晋升周期或离职率是否存在差异。为何重要为薪酬相关活动提供上下文，并可按薪级对流程进行分段分析。获取方式可在UKG Pro的Core HR模块中员工的薪酬或职位档案里查看。示例 IC3M2D1
	角色变更原因 RoleChangeReason	员工岗位变更的原因，例如“晋升”“平调”或“组织调整”。
描述此属性为内部流动事件提供原因维度，用于说明员工在组织内变更岗位或职位的原因。它是“内部流动周期”仪表板与 KPI 的关键，可区分晋升与其他类型的调动。按原因分析能揭示晋升流程是否比平级调动更慢，帮助优化职业发展通道。为何重要解释内部流动的背景，便于区分晋升与平调等情形，开展更细致的内部流动分析。获取方式该信息通常会作为 UKG Pro 的 Core HR 模块中岗位变更或调动流程的一部分被记录。示例晋升平级转岗组织调整

必填推荐可选

Hire to Retire - 员工生命周期活动

为实现准确的流程发现与优化，事件日志应记录的关键步骤和里程碑如下。

6 推荐 9 可选

	活动	描述
	员工已完成入职	重要里程碑，表示已成功完成初始入职清单或工作流。通常意味着新员工所需的入职材料、系统访问申请和初期行政任务均已办结。
为何重要标志初始行政设置结束，可据此分析入职的整体周期时长。此时员工在管理上已准备就绪，可开始履行岗位职责。获取方式位于入职模块。通常根据整体入职工作流的完成时间，或最后一个必做入职任务的完成时间来推断。捕获根据员工主入职清单的完成时间戳推断。事件类型 inferred
	员工已录用	标志在UKG Pro中正式创建员工记录并分配Employee ID。通常在人力资源管理员完成候选人的录用流程后记录，使其在系统中转为在职员工。
为何重要这是“从招聘到退休”流程分析的明确开始事件，为衡量上手速度、入职效率以及整体在职时长提供基线。获取方式该事件通常记录于 HR Core 或 Personnel Administration 模块。可通过员工主雇佣记录的创建日期，或其工作数据历史中的特定“Hire”动作记录来识别。捕获取自员工任职历史表中“Hire”操作的生效日期。事件类型 explicit
	员工雇佣已终止	员工全生命周期中的最终事件，表示雇佣关系正式结束。从离职生效日起，员工记录在系统中转为非活跃状态。
为何重要这是该流程的明确结束事件，对计算员工最终在职时长与分析流失至关重要，也为员工在公司的旅程画上句号。获取方式这是 UKG Pro 的 Core HR 模块中，员工岗位数据历史里最终“Termination”操作的生效日期。系统通常会在该日期将员工状态由在职改为离职。捕获取自员工任职历史中“Termination”操作的生效日期。事件类型 explicit
	已进行绩效评审	表示员工完成一次正式绩效评估周期。经理或HR最终定稿并提交评估表时记录该事件。
为何重要这是员工生命周期中的关键周期性里程碑。跟踪其发生频率与及时性，有助于评估绩效管理合规性及其对职业发展的影响。获取方式位于UKG Pro Performance Management模块。可通过绩效评审表的完成日期，或评审周期状态变更为“Completed”来识别。捕获取自绩效评估工作流实例的完成时间戳。事件类型 explicit
	晋升已批准	表示员工晋升已正式获批，通常包含职位名称变更并常伴随薪酬调整。该事件独立于变更的生效日期，且发生在其之前。
为何重要该活动是分析内部流动与职业晋升的关键。从晋升批准到生效日期的用时，可暴露系统中的行政流程瓶颈。获取方式在HR Core模块的员工任职历史中记录为具体的人事动作，如“晋升”。该记录具有独立的审批日期与生效日期。捕获取自员工任职历史中“Promotion”操作的记录日期。事件类型 explicit
	离职流程发起	表示离职流程开始；当系统录入未来终止日期时即记录该事件，同时触发离职清单与工作流。
为何重要这是启动员工离职流程的关键里程碑。分析该事件与最终终止之间的时间，有助于评估离职办理程序的效率与完备性。获取方式通常指在员工岗位数据中创建一条“Termination”操作记录，并设定未来的生效日期。也可能是在某个模块中启动离职办理工作流的起点。捕获当提交带未来日期的离职交易时记录。事件类型 explicit
	已分配培训	记录向员工分配某个培训课程或学习计划的时间点。通常由系统的学习管理模块记录。
为何重要该活动用于跟踪必修培训的合规情况并监测员工发展。分析从分配到完成的用时，可揭示参与度问题或培训效果。获取方式记录在 UKG Pro 的学习管理或人才管理模块中。每条任务分配都应有相应记录，包含分配日期与员工ID。捕获当课程或学习路径被分配到员工的学习计划时记录。事件类型 explicit
	已发起入职流程	表示在 UKG Pro 中启动新员工入职流程或工作流。该事件通常由系统自动或手动触发，并向新员工、其经理及HR分配清单任务。
为何重要跟踪该活动有助于衡量从正式入职日期到行政与文化融入开始之间的时间。这是分析入职流程效率、识别延误的起点。获取方式位于UKG Pro Onboarding模块。该事件可根据与员工关联的入职清单或工作流实例的创建日期推断。捕获根据员工入职工作流或任务清单的创建时间戳推断。事件类型 inferred
	已进行离职面谈	该事件标记与离职员工的离职面谈已完成，通常记录为离职清单中的一项已完成任务。
为何重要跟踪离职面谈的完成情况，有助于保证HR合规并收集有价值的反馈，也能识别离职流程中这一关键步骤是否被跳过。获取方式该事件通常位于 UKG Pro 的 Onboarding 或 HR Help Desk 模块，作为离职办理工作流中的一个具体任务。是否能被记录，取决于 HR 是否手动将该任务标记为完成。捕获在员工离职清单中记录为已完成的任务。事件类型 explicit
	离职办理完成	里程碑事件，表示所有必办的离职办理任务均已完成，包括资产归还、最终薪资结算和系统权限回收等。
为何重要该事件表明与员工安全、合规分离所需的全部步骤已完成。它有助于衡量离职办理周期并识别合规缺口。获取方式可依据整体离职办理清单或工作流的完成时间戳推断，类似“Employee Onboarded”事件，但用于离职流程。捕获根据员工主离职清单的完成时间戳推断。事件类型 inferred
	经理变更	当员工的“Reports To”或“Manager ID”字段被更新时会生成该事件，表示其直接汇报关系发生变化。
为何重要经理更替会显著影响员工敬业度与绩效。追踪此事件可分析其对后续活动（如绩效评审或留任）的影响。获取方式该事件需通过随时间追踪员工工作数据中经理/主管字段的变化来推断，即比较同一员工相邻记录的经理 ID 是否发生变更。捕获通过检测员工职位数据历史中“Reports To”字段的变更来推断。事件类型 inferred
	薪资设置已完成	表示已录入并核验处理员工薪酬所需的全部信息，如银行账户信息和税务表单。这是确保员工按时准确发薪的关键步骤。
为何重要此里程碑对于衡量新人就绪度至关重要。薪资发放设置的延误会导致员工不满与行政返工，因此是入职环节的重要KPI。获取方式该事件可从 UKG Pro 的 Payroll 模块推断，来源于薪资准备清单的完成日期或员工状态变更为“Ready for Payroll”的日期。捕获来源于员工薪酬档案中的状态变更或完成时间戳。事件类型 inferred
	薪酬已变更	该事件用于记录员工基本薪资、奖金结构或其他薪酬要素的任何变更。它可能源于晋升、绩效调薪或市场调整。
为何重要追踪薪酬变更对于理解职业发展与薪资演进至关重要。入职后频繁调整，可能意味着数据录入错误或初始定薪存在问题。获取方式位于HR Core或Payroll模块的员工薪酬历史表中。每次变更通常会记录生效日期与原因代码。捕获从员工薪酬历史新记录的生效日期起记录。事件类型 explicit
	角色变更已处理	表示员工职位发生非晋升类变动，例如平级调岗或部门转移。系统在相关职位数据更新时记录该事件。
为何重要分析岗位变动可洞察内部流动、人才部署与组织重组，帮助了解员工在组织内的流转路径。获取方式来自UKG Pro的Core HR模块中的员工任职数据历史。可通过“Transfer”“Re-assignment”“Position Change”等职位变动类型及其生效日期进行识别。捕获可通过员工职位历史数据中的“Transfer”等操作代码识别。事件类型 explicit
	长期休假开始	标志员工获批的长期休假开始（如因医疗或个人原因）。当员工状态变为休假（非激活）时记录。
为何重要用于识别员工生命周期中的非活动时段。此信息对准确计算在岗年限、评估休假对职业发展的影响至关重要。获取方式位于HR Core模块的员工职位数据历史中。对应“Leave of Absence”等岗位操作，并包含明确的生效开始日期。捕获取自任职历史中“Start Leave”操作的生效日期。事件类型 explicit

推荐可选

提取指南

如何从UKG Pro获取数据

步骤

前提条件： 请确保已安装 Python 3.6+ 及 requests、pandas 库。可用 pip 安装：pip install requests pandas。
API访问与认证： 联系你的UKG Pro管理员，创建 Service Account。你需要 API Key、User Name 和 Password。该 Service Account 必须具备访问所有所需 API端点的权限，涵盖人事、薪资、入职、绩效和学习等数据。
配置脚本： 用文本编辑器或 IDE 打开提供的 Python 脚本，在顶部找到配置区，将 UKG_BASE_URL、API_KEY、USERNAME、PASSWORD、COMPANY_ID 的占位值替换为你的环境信息和凭据。
设置提取时间范围： 在配置区定义 START_DATE 和 END_DATE，确定要提取的员工变更和事件的时间窗口。建议先用较小范围（如3-6个月）进行测试。
执行脚本： 在命令行运行 python your_script_name.py。脚本会完成认证，并按活动从UKG Pro的各API端点拉取数据，在控制台显示进度。
处理API限流： 脚本内置基础的 time.sleep() 以遵守API速率限制。若出现限流错误（HTTP 429），可适当增加调用间的等待时间。
数据转换与标准化： 每个函数负责获取某项活动的原始数据，选择相关字段，并重命名为标准事件日志格式（EmployeeId、ActivityName、EventTimestamp 等）。
合并事件数据： 主流程将依次调用各活动函数，并把结果追加到统一的事件总列表中。
生成事件日志： 处理完所有活动后，将数据合并为 pandas DataFrame，按员工ID和时间戳排序，保存为 ukg_hire_to_retire_event_log.csv CSV文件。
检查并上传： 打开生成的CSV文件，确认数据完整且格式正确，随后即可上传至流程挖掘工具。

配置

认证凭据：需要使用服务账户的 API Key、User Name 和 Password 进行 API 认证。
基础 URL：您的 UKG Pro 实例的 UKG_BASE_URL（例如：https://service[##].ultipro.com/api）。
Company ID：贵组织在 UKG Pro 中的唯一 COMPANY_ID，是许多 API 调用的必需参数。
日期范围：通过 START_DATE 和 END_DATE 参数（'YYYY-MM-DD' 格式）控制抽取时间范围。首次运行建议选择 3-6 个月的区间，以控制数据量并核验结果。
API 端点版本：脚本会使用特定的 REST API 版本（例如：/personnel/v1/）。请确认您的 UKG Pro 实例支持这些版本。
模块依赖：提取某些活动需要贵组织已购买并实际使用相应的 UKG Pro 模块，例如 Onboarding、Learning、Performance Management。如果未使用某模块，则不会抽取对应的相关活动。

a 查询示例 python

import requests
import pandas as pd
import datetime
import time
import json

class=class="hl-string">"hl-comment"># --- CONFIGURATION --- #
UKG_BASE_URL = class="hl-string">"https://service[YourServiceNumber].ultipro.com/api"
API_KEY = class="hl-string">"[Your_API_Key]"
USERNAME = class="hl-string">"[Your_Service_Account_Username]"
PASSWORD = class="hl-string">"[Your_Service_Account_Password]"
COMPANY_ID = class="hl-string">"[Your_Company_ID]"
START_DATE = (datetime.date.today() - datetime.timedelta(days=180)).strftime(class="hl-string">'%Y-%m-%d')
END_DATE = datetime.date.today().strftime(class="hl-string">'%Y-%m-%d')

class=class="hl-string">"hl-comment"># --- API HELPER FUNCTION --- #

def get_ukg_data(endpoint, params=None):
    class="hl-string">"""Helper function to handle authentication and pagination for UKG API calls."""
    auth_data = json.dumps({
        class="hl-string">"username": USERNAME,
        class="hl-string">"password": PASSWORD,
        class="hl-string">"apiKey": API_KEY
    })
    headers = {class="hl-string">'Content-Type': class="hl-string">'application/json'}
    
    class=class="hl-string">"hl-comment"># Authenticate and get token
    try:
        auth_response = requests.post(fclass="hl-string">"{UKG_BASE_URL}/v1/login", data=auth_data, headers=headers)
        auth_response.raise_for_status()
        token = auth_response.json().get(class="hl-string">'token')
    except requests.exceptions.RequestException as e:
        print(fclass="hl-string">"Authentication failed: {e}")
        return []

    all_records = []
    page = 1
    per_page = 100
    
    api_headers = {class="hl-string">'Authorization': fclass="hl-string">'Bearer {token}'}
    
    while True:
        if params is None:
            params = {}
        params.update({class="hl-string">'page': page, class="hl-string">'per_page': per_page})
        
        try:
            response = requests.get(fclass="hl-string">"{UKG_BASE_URL}{endpoint}", headers=api_headers, params=params)
            response.raise_for_status()
            data = response.json()
            
            if isinstance(data, list) and data:
                all_records.extend(data)
                if len(data) < per_page:
                    break class=class="hl-string">"hl-comment"># Last page
                page += 1
            elif isinstance(data, dict) and class="hl-string">'results' in data:
                all_records.extend(data[class="hl-string">'results'])
                if len(data[class="hl-string">'results']) < per_page:
                    break class=class="hl-string">"hl-comment"># Last page
                page += 1
            else:
                 break class=class="hl-string">"hl-comment"># No more data

            time.sleep(1) class=class="hl-string">"hl-comment"># Respect rate limits

        except requests.exceptions.RequestException as e:
            print(fclass="hl-string">"Error fetching data from {endpoint}: {e}")
            break
            
    return all_records

class=class="hl-string">"hl-comment"># --- ACTIVITY EXTRACTION FUNCTIONS --- #

def get_employee_hired_events():
    print(class="hl-string">"Fetching 'Employee Hired' events...")
    events = []
    class=class="hl-string">"hl-comment"># Use employee changes API to find hire events
    params = {class="hl-string">'action': class="hl-string">'HIRE', class="hl-string">'effectiveDate': fclass="hl-string">'ge {START_DATE}'}
    data = get_ukg_data(class="hl-string">'/personnel/v1/employee-changes', params=params)
    for record in data:
        if record.get(class="hl-string">'effectiveDate') and record.get(class="hl-string">'effectiveDate') <= END_DATE:
            events.append({
                class="hl-string">'EmployeeId': record.get(class="hl-string">'employeeId'),
                class="hl-string">'ActivityName': class="hl-string">'Employee Hired',
                class="hl-string">'EventTimestamp': record.get(class="hl-string">'effectiveDate'),
                class="hl-string">'ActioningUser': record.get(class="hl-string">'changedByUserName'),
                class="hl-string">'EmployeeDepartment': record.get(class="hl-string">'department'),
                class="hl-string">'JobRequisitionId': record.get(class="hl-string">'jobRequisitionId'),
                class="hl-string">'EmploymentStatus': record.get(class="hl-string">'employmentStatus'),
                class="hl-string">'JobTitle': record.get(class="hl-string">'jobTitle'),
                class="hl-string">'ManagerName': record.get(class="hl-string">'supervisorName'),
                class="hl-string">'HireDate': record.get(class="hl-string">'hireDate')
            })
    return events

def get_onboarding_events():
    print(class="hl-string">"Fetching 'Onboarding' events...")
    events = []
    class=class="hl-string">"hl-comment"># Note: Requires Onboarding module. This is a conceptual endpoint.
    class=class="hl-string">"hl-comment"># You may need to adjust the endpoint based on your UKG configuration.
    data = get_ukg_data(fclass="hl-string">'/onboarding/v1/employee-onboarding-activities?start-date={START_DATE}&end-date={END_DATE}')
    for record in data:
        if record.get(class="hl-string">'workflow') == class="hl-string">'New Hire Onboarding':
            if record.get(class="hl-string">'dateAssigned'):
                events.append({
                    class="hl-string">'EmployeeId': record.get(class="hl-string">'employeeId'),
                    class="hl-string">'ActivityName': class="hl-string">'Onboarding Initiated',
                    class="hl-string">'EventTimestamp': record.get(class="hl-string">'dateAssigned'),
                    class="hl-string">'ActioningUser': record.get(class="hl-string">'assignedBy'),
                    class="hl-string">'EmployeeDepartment': record.get(class="hl-string">'department'),
                    class="hl-string">'JobTitle': record.get(class="hl-string">'jobTitle'),
                    class="hl-string">'ManagerName': record.get(class="hl-string">'managerName'),
                    class="hl-string">'HireDate': record.get(class="hl-string">'hireDate')
                })
            if record.get(class="hl-string">'dateCompleted'):
                events.append({
                    class="hl-string">'EmployeeId': record.get(class="hl-string">'employeeId'),
                    class="hl-string">'ActivityName': class="hl-string">'Employee Onboarded',
                    class="hl-string">'EventTimestamp': record.get(class="hl-string">'dateCompleted'),
                    class="hl-string">'ActioningUser': None,
                    class="hl-string">'EmployeeDepartment': record.get(class="hl-string">'department'),
                    class="hl-string">'JobTitle': record.get(class="hl-string">'jobTitle'),
                    class="hl-string">'ManagerName': record.get(class="hl-string">'managerName'),
                    class="hl-string">'HireDate': record.get(class="hl-string">'hireDate')
                })
    return events

def get_payroll_setup_events():
    print(class="hl-string">"Fetching 'Payroll Setup Completed' events...")
    events = []
    class=class="hl-string">"hl-comment"># Inferring this from direct deposit creation date
    params = {class="hl-string">'dateTimeCreated': fclass="hl-string">'ge {START_DATE}'}
    data = get_ukg_data(class="hl-string">'/personnel/v1/employees/direct-deposit', params=params)
    processed_employees = set()
    for record in data:
        if record.get(class="hl-string">'employeeId') not in processed_employees and record.get(class="hl-string">'dateTimeCreated') <= END_DATE:
            events.append({
                class="hl-string">'EmployeeId': record.get(class="hl-string">'employeeId'),
                class="hl-string">'ActivityName': class="hl-string">'Payroll Setup Completed',
                class="hl-string">'EventTimestamp': record.get(class="hl-string">'dateTimeCreated'),
                class="hl-string">'ActioningUser': record.get(class="hl-string">'userWhoModified'),
                class="hl-string">'EmploymentStatus': record.get(class="hl-string">'employeeStatus')
            })
            processed_employees.add(record.get(class="hl-string">'employeeId'))
    return events

def get_training_assigned_events():
    print(class="hl-string">"Fetching 'Training Assigned' events...")
    events = []
    class=class="hl-string">"hl-comment"># Note: Requires Learning module.
    params = {class="hl-string">'assignmentDate': fclass="hl-string">'ge {START_DATE}'}
    data = get_ukg_data(class="hl-string">'/learning/v1/enrollments', params=params)
    for record in data:
        if record.get(class="hl-string">'assignmentDate') <= END_DATE:
            events.append({
                class="hl-string">'EmployeeId': record.get(class="hl-string">'employee').get(class="hl-string">'id'),
                class="hl-string">'ActivityName': class="hl-string">'Training Assigned',
                class="hl-string">'EventTimestamp': record.get(class="hl-string">'assignmentDate'),
                class="hl-string">'ActioningUser': record.get(class="hl-string">'assignedBy').get(class="hl-string">'name'),
                class="hl-string">'JobTitle': record.get(class="hl-string">'employee').get(class="hl-string">'jobTitle')
            })
    return events

def get_performance_review_events():
    print(class="hl-string">"Fetching 'Performance Review' events...")
    events = []
    class=class="hl-string">"hl-comment"># Note: Requires Performance Management module.
    params = {class="hl-string">'completionDate': fclass="hl-string">'ge {START_DATE}'}
    data = get_ukg_data(class="hl-string">'/performance/v1/reviews', params=params)
    for record in data:
        if record.get(class="hl-string">'completionDate') <= END_DATE:
            events.append({
                class="hl-string">'EmployeeId': record.get(class="hl-string">'employee').get(class="hl-string">'id'),
                class="hl-string">'ActivityName': class="hl-string">'Performance Review Conducted',
                class="hl-string">'EventTimestamp': record.get(class="hl-string">'completionDate'),
                class="hl-string">'ActioningUser': record.get(class="hl-string">'manager').get(class="hl-string">'name'),
                class="hl-string">'ManagerName': record.get(class="hl-string">'manager').get(class="hl-string">'name')
            })
    return events

def get_job_change_events():
    print(class="hl-string">"Fetching job and compensation change events...")
    events = []
    params = {class="hl-string">'effectiveDate': fclass="hl-string">'ge {START_DATE}'}
    data = get_ukg_data(class="hl-string">'/personnel/v1/employee-changes', params=params)
    for record in data:
        if record.get(class="hl-string">'effectiveDate') > END_DATE: continue

        action = record.get(class="hl-string">'action', class="hl-string">'').upper()
        reason = record.get(class="hl-string">'reason', class="hl-string">'').upper()
        
        if action == class="hl-string">'PROMOTION' or reason == class="hl-string">'PROMOTION':
            events.append({
                class="hl-string">'EmployeeId': record.get(class="hl-string">'employeeId'),
                class="hl-string">'ActivityName': class="hl-string">'Promotion Approved',
                class="hl-string">'EventTimestamp': record.get(class="hl-string">'effectiveDate'),
                class="hl-string">'ActioningUser': record.get(class="hl-string">'changedByUserName'),
                class="hl-string">'JobTitle': record.get(class="hl-string">'jobTitle'),
                class="hl-string">'ManagerName': record.get(class="hl-string">'supervisorName')
            })

        if action == class="hl-string">'TRANSFER' or reason == class="hl-string">'TRANSFER' or reason == class="hl-string">'REASSIGNMENT':
            events.append({
                class="hl-string">'EmployeeId': record.get(class="hl-string">'employeeId'),
                class="hl-string">'ActivityName': class="hl-string">'Role Change Processed',
                class="hl-string">'EventTimestamp': record.get(class="hl-string">'effectiveDate'),
                class="hl-string">'ActioningUser': record.get(class="hl-string">'changedByUserName'),
                class="hl-string">'EmployeeDepartment': record.get(class="hl-string">'department'),
                class="hl-string">'JobTitle': record.get(class="hl-string">'jobTitle')
            })

        if record.get(class="hl-string">'isPayRateChanged') == class="hl-string">'true':
            events.append({
                class="hl-string">'EmployeeId': record.get(class="hl-string">'employeeId'),
                class="hl-string">'ActivityName': class="hl-string">'Compensation Changed',
                class="hl-string">'EventTimestamp': record.get(class="hl-string">'effectiveDate'),
                class="hl-string">'ActioningUser': record.get(class="hl-string">'changedByUserName'),
                class="hl-string">'EmploymentStatus': record.get(class="hl-string">'employmentStatus')
            })

        if record.get(class="hl-string">'isSupervisorChanged') == class="hl-string">'true':
            events.append({
                class="hl-string">'EmployeeId': record.get(class="hl-string">'employeeId'),
                class="hl-string">'ActivityName': class="hl-string">'Manager Changed',
                class="hl-string">'EventTimestamp': record.get(class="hl-string">'effectiveDate'),
                class="hl-string">'ActioningUser': record.get(class="hl-string">'changedByUserName'),
                class="hl-string">'ManagerName': record.get(class="hl-string">'supervisorName')
            })
    return events

def get_leave_events():
    print(class="hl-string">"Fetching 'Leave of Absence' events...")
    events = []
    params = {class="hl-string">'action': class="hl-string">'LEAVE', class="hl-string">'effectiveDate': fclass="hl-string">'ge {START_DATE}'}
    data = get_ukg_data(class="hl-string">'/personnel/v1/employee-changes', params=params)
    for record in data:
        if record.get(class="hl-string">'effectiveDate') and record.get(class="hl-string">'effectiveDate') <= END_DATE:
            events.append({
                class="hl-string">'EmployeeId': record.get(class="hl-string">'employeeId'),
                class="hl-string">'ActivityName': class="hl-string">'Leave of Absence Started',
                class="hl-string">'EventTimestamp': record.get(class="hl-string">'effectiveDate'),
                class="hl-string">'ActioningUser': record.get(class="hl-string">'changedByUserName'),
                class="hl-string">'EmploymentStatus': record.get(class="hl-string">'employmentStatus'),
                class="hl-string">'HireDate': record.get(class="hl-string">'hireDate')
            })
    return events

def get_termination_events():
    print(class="hl-string">"Fetching 'Termination' events...")
    events = []
    params = {class="hl-string">'action': class="hl-string">'TERM', class="hl-string">'effectiveDate': fclass="hl-string">'ge {START_DATE}'}
    data = get_ukg_data(class="hl-string">'/personnel/v1/employee-changes', params=params)
    for record in data:
        if record.get(class="hl-string">'effectiveDate') and record.get(class="hl-string">'effectiveDate') <= END_DATE:
            class=class="hl-string">"hl-comment"># Termination Initiated is when the record is created, Terminated is the effective date
            events.append({
                class="hl-string">'EmployeeId': record.get(class="hl-string">'employeeId'),
                class="hl-string">'ActivityName': class="hl-string">'Termination Initiated',
                class="hl-string">'EventTimestamp': record.get(class="hl-string">'dateCreated'),
                class="hl-string">'ActioningUser': record.get(class="hl-string">'changedByUserName'),
                class="hl-string">'EmploymentStatus': record.get(class="hl-string">'employmentStatus'),
                class="hl-string">'HireDate': record.get(class="hl-string">'hireDate')
            })
            events.append({
                class="hl-string">'EmployeeId': record.get(class="hl-string">'employeeId'),
                class="hl-string">'ActivityName': class="hl-string">'Employee Terminated',
                class="hl-string">'EventTimestamp': record.get(class="hl-string">'effectiveDate'),
                class="hl-string">'ActioningUser': record.get(class="hl-string">'changedByUserName'),
                class="hl-string">'EmploymentStatus': class="hl-string">'Terminated',
                class="hl-string">'HireDate': record.get(class="hl-string">'hireDate')
            })
    return events

def get_offboarding_events():
    print(class="hl-string">"Fetching 'Offboarding' events...")
    events = []
    class=class="hl-string">"hl-comment"># Note: Requires Onboarding module for offboarding checklists.
    class=class="hl-string">"hl-comment"># Conceptual endpoint, may need adjustment.
    data = get_ukg_data(fclass="hl-string">'/onboarding/v1/employee-onboarding-activities?start-date={START_DATE}&end-date={END_DATE}')
    for record in data:
        if record.get(class="hl-string">'workflow') == class="hl-string">'Employee Offboarding':
            if record.get(class="hl-string">'stepName') == class="hl-string">'Exit Interview' and record.get(class="hl-string">'dateCompleted'):
                events.append({
                    class="hl-string">'EmployeeId': record.get(class="hl-string">'employeeId'),
                    class="hl-string">'ActivityName': class="hl-string">'Exit Interview Conducted',
                    class="hl-string">'EventTimestamp': record.get(class="hl-string">'dateCompleted'),
                    class="hl-string">'ActioningUser': record.get(class="hl-string">'completedBy')
                })
            if record.get(class="hl-string">'dateCompleted') and record.get(class="hl-string">'isWorkflowComplete'):
                events.append({
                    class="hl-string">'EmployeeId': record.get(class="hl-string">'employeeId'),
                    class="hl-string">'ActivityName': class="hl-string">'Offboarding Completed',
                    class="hl-string">'EventTimestamp': record.get(class="hl-string">'dateCompleted'),
                    class="hl-string">'ActioningUser': None
                })
    return events

class=class="hl-string">"hl-comment"># --- MAIN EXECUTION --- #
if __name__ == class="hl-string">"__main__":
    all_events = []
    last_data_update = datetime.datetime.utcnow().isoformat() + class="hl-string">'Z'

    class=class="hl-string">"hl-comment"># Collect events from all functions
    all_events.extend(get_employee_hired_events())
    all_events.extend(get_onboarding_events())
    all_events.extend(get_payroll_setup_events())
    all_events.extend(get_training_assigned_events())
    all_events.extend(get_performance_review_events())
    all_events.extend(get_job_change_events())
    all_events.extend(get_leave_events())
    all_events.extend(get_termination_events())
    all_events.extend(get_offboarding_events())

    if not all_events:
        print(class="hl-string">"No events found for the specified period. Exiting.")
    else:
        class=class="hl-string">"hl-comment"># Create DataFrame
        df = pd.DataFrame(all_events)
        
        class=class="hl-string">"hl-comment"># Add required static columns
        df[class="hl-string">'SourceSystem'] = class="hl-string">'UKG Pro'
        df[class="hl-string">'LastDataUpdate'] = last_data_update
        
        class=class="hl-string">"hl-comment"># Standardize and clean up
        df = df.rename(columns={class="hl-string">'employeeId': class="hl-string">'EmployeeId', class="hl-string">'activityName': class="hl-string">'ActivityName', class="hl-string">'eventTimestamp': class="hl-string">'EventTimestamp'})
        df[class="hl-string">'EventTimestamp'] = pd.to_datetime(df[class="hl-string">'EventTimestamp']).dt.strftime(class="hl-string">'%Y-%m-%dT%H:%M:%S.%f')[:-3] + class="hl-string">'Z'
        df = df.sort_values(by=[class="hl-string">'EmployeeId', class="hl-string">'EventTimestamp'])
        
        class=class="hl-string">"hl-comment"># Reorder columns for clarity
        column_order = [
            class="hl-string">'EmployeeId', class="hl-string">'ActivityName', class="hl-string">'EventTimestamp', class="hl-string">'SourceSystem', class="hl-string">'LastDataUpdate',
            class="hl-string">'ActioningUser', class="hl-string">'EmployeeDepartment', class="hl-string">'JobRequisitionId', class="hl-string">'EmploymentStatus',
            class="hl-string">'JobTitle', class="hl-string">'ManagerName', class="hl-string">'HireDate'
        ]
        df = df.reindex(columns=column_axist)

        class=class="hl-string">"hl-comment"># Save to CSV
        output_filename = class="hl-string">'ukg_hire_to_retire_event_log.csv'
        df.to_csv(output_filename, index=False)
        print(fclass="hl-string">"\nExtraction complete. Event log saved to {output_filename}")

数据模板：招聘到退休—员工生命周期

您的从招聘到退休——员工全生命周期数据模板

Hire to Retire - 员工生命周期属性

Hire to Retire - 员工生命周期活动

提取指南

通过 UKG Pro REST API 用 Python 脚本抽取数据

步骤

配置

a 查询示例 python

准备好开始了吗？

立即优化您的“从招聘到退休”员工生命周期！