薪资处理数据模板

UKG Pro

← 返回改进指南

薪资处理属性(19) 薪资处理活动(15) 数据提取指南(2)

薪资处理数据模板

此模板为梳理UKG Pro中的薪资周期提供了结构基础，帮助您获得可执行的洞察。模板列出了深入分析所需的属性、建议监控的具体流程步骤，以及从系统环境中收集相关信息的方法。按照模板整理数据，您便能有效定位低效环节并确保薪资处理符合合规要求。

用于薪资分析的标准化数据属性
在UKG Pro中跟踪的关键流程节点
系统集成的技术数据提取指南

刚接触事件日志？了解如何创建流程挖掘事件日志.

下载模板

薪资处理属性

此表列出了薪资流程分析所需的建议数据字段和上下文元数据，用于构建完整的事件日志。

5 必填 11 建议填写 3 选填

	名称	说明
	最后更新日期 LastUpdateDate	数据行最近一次修改的时间戳。
说明此属性表示数据库中记录的最后修改时间。它与事件时间戳相似，但主要用于增量数据加载和数据完整性检查。该属性可确保流程挖掘模型反映薪资记录的最新状态，并纳入薪资专员所做的延迟调整或追溯更正。重要性用于增量数据刷新的必填属性。获取途径 LastModifiedDate等系统元数据列示例 2023-10-05T17:00:00Z2023-10-06T09:00:00Z
	时间戳 EventTimestamp	活动发生的日期和时间。
说明此属性记录活动发生的准确时间，对于正确排列事件顺序和计算步骤间的耗时至关重要。建议使用高精度时间戳，以区分短时间内连续发生的自动化步骤。在薪资流程中，该属性用于仪表板分析周期时间分布和SLA合规情况。没有准确的时间戳，就无法衡量税前工资到税后工资的计算速度，也无法确定工时表审批的延迟时间。重要性这是用于排列事件顺序的必填StartTime属性。获取途径与交易状态变更相关的日期/时间列示例 2023-10-01T09:15:00Z2023-10-01T14:30:45Z2023-10-03T08:00:00Z
	活动 ActivityName	薪资流程中执行的具体事件或步骤。
说明此属性记录薪资工作流中各步骤的名称，例如提交工时表、计算税前工资或执行付款。它定义了流程图中的流程走向。这些值通常从UKG Pro环境中的审计日志、系统状态变更表或带时间戳的交易更新中提取。数据转换时会统一命名规则，确保流程图清晰易读。重要性这是必填的活动属性，用于定义流程图中的节点。获取途径系统审计日志、工作流历史记录或交易时间戳列示例工时表已提交总薪资已计算付款已执行
	源系统 SourceSystem	数据的记录系统。
说明此属性用于标识数据记录的来源。在此场景中，该值固定为UKG Pro（如果存在多个实例，则填写具体实例名称）。在多系统流程挖掘中，这一点至关重要，因为薪资数据可能需要与ERP中的总账数据结合分析。分析人员可以据此筛选视图，只查看源自薪资平台的步骤，或区分与外部考勤系统集成的步骤。重要性用于数据沿袭和多系统分析的必填属性。获取途径固定值或系统配置表示例 UKG ProUltiPro旧版时间管理系统
	薪资记录 PayrollRecordId	用于标识特定薪资周期内某位员工的唯一标识符。
说明薪资记录是流程挖掘分析的核心案例标识符。它通常由员工ID与薪资周期结束日期（或薪资组实例）组合而成，确保每位员工的每个薪资周期都作为独立案例处理，从而分析流程随时间的重复情况。在UKG Pro中，该标识符通常是从Payroll Header表或类似交易记录中提取的复合键。按此ID分组后，分析人员可以还原从提交工时表到最终付款和税务申报的端到端流程。重要性这是必填的案例ID，用于将所有薪资活动归为同一个流程实例。获取途径从UKG Pro Payroll Header表或Employee Pay History表中提取示例 EMP001-20231015EMP492-20231031EMP883-20231115
	SLA截止时间 SlaProcessingDeadline	完成付款执行的目标日期和时间。
说明此属性定义薪资流程必须完成的内部或外部截止时间，以确保银行转账及时到账。它是SLA合规与截止时间监控仪表板的核心属性。将实际付款执行时间戳与此截止时间比较，即可计算按时完成率，并优先呈现有延误风险的记录。重要性用于计算SLA达标情况的参考时间点。获取途径薪资日历，或根据发薪日减去银行处理天数推算示例 2023-10-13T16:00:00Z2023-10-28T16:00:00Z
	成本中心 CostCenter	用于财务分配的成本中心代码。
说明成本中心属性用于定义薪资费用在总账中的分配位置。它与部门属性相似，但通常能提供更细致的财务视角。该属性用于工时跟踪审批绩效仪表板，可帮助识别审批层级较慢的成本中心。在税前工资到税后工资的计算阶段，它还有助于验证薪资费用是否计入正确的财务科目。重要性支持财务分析，并按预算单元识别瓶颈。获取途径员工职位表或分配表示例 CC-5001CC-9002Overhead-Corp
	是否为非周期薪资 IsOffCycle	用于标记薪资批次是否在标准计划之外执行。
说明此布尔属性用于标识薪资记录是否属于非周期批次，并用于计算非周期薪资量KPI。非周期批次通常成本更高，也需要更多人工处理。按此标记筛选流程变体路径分析仪表板，可以查看为更正错误或临时付款而采取的非标准路径。重要性用于分析流程偏差和返工的关键筛选条件。获取途径 Payroll Header中的“Check Date”与“Period End Date”逻辑示例 truefalse
	是否存在审计异常 HasAuditException	用于标记是否触发审计异常。
说明此布尔属性用于标记该案例是否曾发生“标记审计异常”活动，并支持首次处理薪资准确率KPI。分析人员可以据此快速区分“无异常”案例和需要干预的案例，便于在审计异常与更正趋势仪表板中分析返工原因。重要性识别需要干预的案例。获取途径根据是否存在“标记审计异常”活动推导示例 truefalse
	是否违反SLA IsSlaBreached	用于标记付款是否在截止时间之后执行。
说明此布尔属性是一个计算指标，用于比较“付款执行”时间戳与“SLA截止时间”，直接影响薪资SLA达标率KPI。预先计算该属性后，可以立即筛选仪表板，仅显示存在问题的案例，便于分析错过截止时间的根因。重要性用于合规监控的KPI驱动指标。获取途径计算方式：PaymentTime > SlaDeadline 示例 truefalse
	税前工资金额 GrossPayAmount	扣除款项和税费前计算出的工资总额。
说明此属性表示该记录计算出的税前工资金额，并映射到ActivityAmount，以支持基于成本的流程分析。分析税前工资金额有助于薪资税前到税后计算速度仪表板的分析。仪表板主要衡量耗时，但将耗时与付款的复杂程度和金额关联起来，可以发现高额付款或复杂佣金计算是否导致绩效问题。重要性支持价值流分析和异常值检测。获取途径 Payroll Result表或Pay Register表示例 2500.0010500.50480.00
	税务管辖区 TaxJurisdiction	用于税务申报的主要州或地方辖区。
说明此属性用于标识与薪资记录关联的主要税务管辖区。它对于多州税务申报时间线仪表板至关重要。按税务管辖区分析流程后，合规团队可以发现哪些州的申报完成时间持续较长，或多州员工是否比单州员工更容易触发审计异常。重要性对于合规监控和地理分析至关重要。获取途径 Tax Location表或Employee Tax表示例 CANYTX
	薪资专员 PayrollSpecialist	处理该记录的人员用户ID或姓名。
说明此属性用于标识负责审批记录、修正数据或执行付款批次的薪资管理员或专员，并映射到通用用户属性。这些数据对于专员工作量和处理量仪表板至关重要。管理人员可以查看团队内的工作分配情况，并识别是否有人负担过重，或在审批阶段形成瓶颈。重要性支持资源分析和工作量平衡分析。获取途径审计日志或交易表中的“ModifiedBy”列示例 jsmithmdoesystem_admin
	薪资周期结束日期 PayPeriodEndDate	当前处理的薪资周期最后一天。
说明此属性标记薪资周期的结束日期，是判断提交是否延迟的重要参考点。结合“提交工时表”活动的StartTime，可计算延迟时长；它也是薪资周期时间分布仪表板的重要分组维度。重要性薪资周期的时间基准点。获取途径 Payroll Header表或Time Period Configuration表示例 2023-09-302023-10-15
	薪资组 PayGroup	用于薪资处理的员工逻辑分组。
说明薪资组是UKG Pro中的一项基础配置，用于规定一组员工的发薪频率（每周、每两周）和处理规则，也是主要的批次标识符。该属性对于薪资周期时间分布仪表板至关重要。通过它可以比较不同群体的处理绩效，例如高管薪资组与工厂小时工组，并识别特定配置是否造成系统性延迟。重要性用于分组和比较薪资绩效的主要维度。获取途径 Payroll Header表或Pay Group Configuration表示例 US-BiWeeklyCA-WeeklyExec-Monthly
	部门 DepartmentCode	与员工关联的部门代码。
说明此属性将薪资记录关联到特定组织单元。它对于审计异常与更正趋势仪表板至关重要，可帮助组织了解哪些部门经常出错或需要人工干预。按部门细分数据后，分析人员可以判断是否需要为特定经理提供工时表审批培训，或是否有业务单元因薪资规则复杂而导致计算延迟。重要性对于组织细分和根因分析至关重要。获取途径员工主数据表或职位历史表示例 DEPT-100FINANCE-01OPS-WEST
	员工类型 EmployeeType	员工类别，例如全职、兼职或合同工。
说明此属性用于对薪资记录关联的员工进行分类，并用于工时跟踪审批绩效仪表板。不同员工类型的工时表提交习惯和审批工作流往往不同。按此属性细分数据，有助于区分系统性流程问题与特定员工群体的行为模式。重要性按员工类别细分分析。获取途径员工主数据表示例全职兼职合同工
	更正类别 CorrectionCategory	所执行的数据更正类型，例如工时、费率或扣款。
说明发生数据更正活动时，此属性用于记录更正内容。它对于人工数据更正率KPI至关重要。了解更正主要涉及“工时录入”还是“福利扣款”，有助于企业针对特定上游系统或团队改进流程。重要性细分返工原因。获取途径审计日志中的“Field Changed”列示例工时录入调整追溯补发工资更新税码
	激励数据来源 IncentiveSource	激励数据的来源，例如SalesForce或Excel导入。
说明此属性用于标识导入薪资记录的激励或佣金数据来源，并支持激励数据导入准确率仪表板。将此属性与激励数据返工频率KPI关联分析，团队可以判断特定上游文件（例如东北地区销售报告）是否经常出现格式错误或数据质量问题。重要性追溯外部数据提供方导致的质量问题。获取途径导入日志文件名或批次ID说明示例销售佣金数据流手动上传奖金数据高管薪酬系统

必填建议填写选填

薪资处理活动

在事件日志中记录这些关键流程步骤和节点，以准确发现流程并识别瓶颈。

4 建议填写 11 选填

	活动	说明
	付款已执行	资金实际转入员工账户的日期或生效日期，标志着薪酬支付义务已履行。
重要性用于核验“SLA达成情况”，确保员工在承诺日期收到薪资。获取途径使用已完成的薪资表头记录中的“支票日期”或“付款通知日期”字段。采集执行交易payment_post时记录事件类型 explicit
	税务申报已完成	成功向相关司法辖区（联邦、州和地方）提交税务数据。此步骤通常在付款后进行。
重要性此数据对于“多州税务申报时间表”仪表板至关重要，有助于确保符合监管要求并避免罚款。获取途径从税务申报接口或支付服务日志中获取状态更新为“已申报”或“已接受”的记录。采集执行交易tax_file_transmit时记录事件类型 explicit
	薪资记录已初始化	在新的薪资组实例中，为员工创建具体薪资明细项。这表明员工已启用并纳入当前处理周期。
重要性标记核心系统中薪资处理阶段的正式开始时间。此数据对于区分工时记录时长与实际薪资处理时长至关重要。获取途径查找记录插入员工薪资表或支票表头表时的时间戳，并确认对应的付款日期。采集执行交易pay_period_create时记录事件类型 explicit
	薪资记录已批准	对单条记录或整个薪资组进行最终签核。此操作会锁定记录，禁止进一步修改，并将其加入付款生成队列。
重要性这是区分处理阶段与最终完成阶段的关键节点，可用于计算“银行转账文件准备时间”。获取途径从薪资周期控制表中获取薪资组或单条支票记录的状态变为“已批准”或“已锁定”时的记录。采集执行交易approve_pay_group时记录事件类型 explicit
	审计异常已标记	系统或用户发现差异，例如负薪资、缺少税码或SLA警示。此时记录需要进一步处理。
重要性此数据直接用于“审计异常与更正趋势”仪表板。此类记录数量较多，说明上游数据质量存在问题。获取途径查找系统警告日志或薪资周期消息表中与特定员工ID相关的记录。采集执行交易validation_warning时记录事件类型 explicit
	工时表已批准	经理审批已提交的工时，并确认其可用于付款处理。完成此步骤后，数据即可导入薪资计算引擎。
重要性对此步骤进行瓶颈分析，可以发现管理审核造成的延迟，以及这些延迟如何压缩薪资专员处理数据的可用时间。获取途径从工时管理历史记录中获取状态变为“已批准”或“已签核”时的记录。采集执行交易time_card_approve时记录事件类型 explicit
	工时表已提交	员工或经理提交本薪资周期工时卡时记录的事件。这标志着原始工时数据进入整体薪资工作流。提交操作也可能先在工时管理模块中完成，再传入核心薪资系统。
重要性确定端到端薪资周期最早的开始时间戳。此数据对于衡量实际工作完成到薪资数据录入之间的延迟至关重要。获取途径从工时管理审计日志或工时卡历史表中获取状态变为“已提交”时的记录。采集执行交易time_card_submit时记录事件类型 explicit
	总薪资已计算	系统首次运行计算，根据工时、费率和激励金数据确定总收入。此步骤在扣款和税款计算之前进行。
重要性测量从此步骤到“税款已计算”的耗时，可得出用于系统性能分析的“总额到净额计算速度”指标。获取途径根据系统作业日志中计算批次的“开始时间”推断。采集比较计算作业启动前后的状态字段事件类型 inferred
	数据已更正	初次计算后、最终审批前，对薪资记录进行的手动修改，例如调整工时或覆盖税额。
重要性这是衡量返工的主要指标。跟踪此数据可计算“手动数据更正率”KPI。获取途径从审计日志中获取员工薪资明细表或扣款表的更新记录，并筛选用户ID不是“System”的记录。采集执行交易update_pay_detail时记录事件类型 explicit
	激励金数据已导入	导入佣金、奖金或一次性付款等外部薪酬数据。此类数据不同于常规工时，通常通过批量文件上传。
重要性此活动之后若失败率较高或需要返工，通常说明数据映射或外部文件质量存在问题，这也是薪资延误的常见原因。获取途径从系统日志或批量导入历史记录中获取文件类型为“Incentives”或“Additional Pay”的记录。采集执行交易import_batch_data时记录事件类型 explicit
	福利扣款已应用	系统从总薪资中扣除税前和税后福利款项（医疗保险、401k）。通常在确定总薪资后立即执行此逻辑。
重要性此处发生错误通常需要手动更正。单独分析此步骤，有助于判断延迟是由福利引擎还是配置问题造成的。获取途径根据计算批次的时间戳推断，或查看员工扣款历史表中的创建时间戳。采集通过比较字段calculation_stage推导事件类型 inferred
	税款已计算	计算引擎的最后阶段，应用多州税务逻辑以确定净薪资。此步骤完成自动计算阶段。
重要性此步骤完成“总额到净额”计算流程。耗时过长可能说明税务引擎性能存在问题，或多辖区配置较为复杂。获取途径根据系统作业日志中计算批次的“结束时间”或员工税务表中的时间戳推断。采集比较计算作业结束前后的状态字段事件类型 inferred
	薪资单已发布	员工可在自助服务门户中查看薪资单，至此信息传达流程完成。
重要性虽然此步骤不会阻碍技术处理，但发布延迟会增加服务台来电，并影响员工满意度。获取途径根据薪资组配置中的“支票日期”或特定的“自助服务发布日期”设置推断。采集通过比较字段check_date与release_policy推导事件类型 inferred
	薪资结果已预览	用户打开薪资登记表或预览报告，核验计算结果。这标志着流程从自动处理转入人工审核。
重要性标记核验阶段的开始时间。计算完成到预览之间间隔过长，可能说明资源不足。获取途径从审计日志中获取用户访问“薪资登记表”或“预检”报告的记录。采集执行交易report_view_preview时记录事件类型 explicit
	银行转账文件已生成	生成用于发送至银行的NACHA或直接存款文件，为资金转账做好准备。
重要性此处延误会直接导致错过银行截止时间。此数据用于“银行转账生成速度”仪表板。获取途径从系统作业日志中获取ACH/直接存款文件生成作业完成时的时间戳。采集执行交易create_ach_file时记录事件类型 explicit

建议填写选填

数据提取指南

如何从UKG Pro获取数据

步骤

使用具有商业智能（BI）报表编写权限的账户登录UKG Pro。
进入Administration，选择Business Intelligence，启动IBM Cognos Analytics。
新建报告并选择Blank模板。选择List可视化开始创建。
您需要添加数据模块。由于数据分属不同领域，必须创建多查询结构。进入Cognos中的Query Explorer视图。
创建15个独立的Query主题，每个主题对应一项所列活动（例如Query_TimeSubmit、Query_PayCalc）。分别映射数据源包：工时活动使用Time Management，计算和付款活动使用Payroll，修改和审批活动使用System Audit。
对每个Query主题，将相关时间戳和标识符拖入Data Items窗格。每个查询都必须创建名为ActivityName的计算数据项，并为其设置硬编码字符串（例如“Time Sheet Submitted”）。
确保每个查询输出完全相同的列：PayrollRecordId（由EmployeeID和PayDate拼接而成）、ActivityName、EventTimestamp及其他必需属性。对于特定步骤不适用的指标，使用0或NULL，以确保列对齐。
在Query Explorer中创建Union Query。将全部15个独立查询拖入该Union Query，以执行“UNION ALL”操作，纵向合并数据。
返回Report Page设计视图，将List对象指向刚创建的Union Query。
为报告添加筛选器，将“Pay Period End Date”限制在所需的数据提取时间范围内（例如最近90天），以保证报告性能。
先以HTML格式运行报告，检查数据行。确认不同活动类型的列均正确对齐。
将报告保存为“ProcessMind_Extraction_Report”。设置每周运行一次，并将输出作为CSV文件发送到您的SFTP服务器，供ProcessMind导入。

配置

数据包：需要在UKG Business Intelligence中访问Payroll、Time Management和System Audit数据包。
权限：运行报告的用户必须有权查看敏感薪资数据（Gross Pay）和审计日志。
日期范围：建议按“Pay Period End Date”而非“Transaction Date”筛选，以保留完整案例历史。建议先使用滚动6个月的时间范围。
标识符构建：案例ID（PayrollRecordId）必须保持一致。将员工编号与发薪期结束日期拼接（格式：EMP123-20231031），以唯一标识该周期。
性能：System Audit表可能非常庞大。请专门为Audit查询设置严格的日期筛选，以避免超时。
时区：UKG Pro通常以UTC或服务器时间存储时间。请确认时差；如果事件日志需要本地时间，请应用相应计算（例如_add_hours）。

查询示例 sql

/* 
   UKG PRO COGNOS ANALYTICS - REPORT SPECIFICATION LOGIC 
   Language: Cognos Expression / Pseudo-SQL Configuration
   NOTE: This logic represents the 15 segments required in the Union Query.
   Each block represents a separate Query Subject in Cognos that must be Unioned.
*/

/* 1. Time Sheet Submitted */
SELECT
  ([TimeMgmt].[EmployeeID] + '-' + [TimeMgmt].[PayPeriodEnd]) AS PayrollRecordId,
  'Time Sheet Submitted' AS ActivityName,
  [TimeMgmt].[Timecard_Submission_Date] AS EventTimestamp,
  'UKG Time' AS SourceSystem,
  [TimeMgmt].[Last_Updated] AS LastUpdateDate,
  [TimeMgmt].[Approver_ID] AS PayrollSpecialist,
  [TimeMgmt].[Gross_Pay_Est] AS GrossPayAmount,
  [TimeMgmt].[Department] AS DepartmentCode,
  [TimeMgmt].[PayGroup] AS PayGroup
FROM [Time Management Package]
WHERE [TimeMgmt].[Status] = 'Submitted'

UNION ALL

/* 2. Time Sheet Approved */
SELECT
  ([TimeMgmt].[EmployeeID] + '-' + [TimeMgmt].[PayPeriodEnd]) AS PayrollRecordId,
  'Time Sheet Approved' AS ActivityName,
  [TimeMgmt].[Timecard_Approval_Date] AS EventTimestamp,
  'UKG Time' AS SourceSystem,
  [TimeMgmt].[Last_Updated] AS LastUpdateDate,
  [TimeMgmt].[Manager_ID] AS PayrollSpecialist,
  [TimeMgmt].[Gross_Pay_Est] AS GrossPayAmount,
  [TimeMgmt].[Department] AS DepartmentCode,
  [TimeMgmt].[PayGroup] AS PayGroup
FROM [Time Management Package]
WHERE [TimeMgmt].[Status] = 'Approved'

UNION ALL

/* 3. Payroll Record Initialized */
SELECT
  ([PayRegister].[EmployeeID] + '-' + [PayRegister].[PeriodEndDate]) AS PayrollRecordId,
  'Payroll Record Initialized' AS ActivityName,
  [PayRegister].[Record_Creation_Date] AS EventTimestamp,
  'UKG Payroll' AS SourceSystem,
  [PayRegister].[Last_Mod_Date] AS LastUpdateDate,
  'System' AS PayrollSpecialist,
  0 AS GrossPayAmount,
  [PayRegister].[Home_Dept] AS DepartmentCode,
  [PayRegister].[PayGroup] AS PayGroup
FROM [Payroll Data Package]

UNION ALL

/* 4. Incentive Data Imported */
SELECT
  ([PayDetail].[EmployeeID] + '-' + [PayDetail].[PeriodEndDate]) AS PayrollRecordId,
  'Incentive Data Imported' AS ActivityName,
  [PayDetail].[Import_Date] AS EventTimestamp,
  'UKG Payroll' AS SourceSystem,
  [PayDetail].[Import_Date] AS LastUpdateDate,
  [PayDetail].[User_ID] AS PayrollSpecialist,
  [PayDetail].[Amount] AS GrossPayAmount,
  [PayDetail].[Department] AS DepartmentCode,
  [PayDetail].[PayGroup] AS PayGroup
FROM [Payroll Detail Package]
WHERE [PayDetail].[Source_Type] = 'Import' AND [PayDetail].[Earn_Ded_Type] = 'Earning'

UNION ALL

/* 5. Gross Pay Calculated */
SELECT
  ([PayHistory].[EmployeeID] + '-' + [PayHistory].[PeriodEndDate]) AS PayrollRecordId,
  'Gross Pay Calculated' AS ActivityName,
  [PayHistory].[Calculation_Time] AS EventTimestamp,
  'UKG Calc Engine' AS SourceSystem,
  [PayHistory].[Calculation_Time] AS LastUpdateDate,
  'System' AS PayrollSpecialist,
  [PayHistory].[Total_Gross] AS GrossPayAmount,
  [PayHistory].[Department] AS DepartmentCode,
  [PayHistory].[PayGroup] AS PayGroup
FROM [Payroll History Package]

UNION ALL

/* 6. Benefits Deductions Applied */
SELECT
  ([PayHistory].[EmployeeID] + '-' + [PayHistory].[PeriodEndDate]) AS PayrollRecordId,
  'Benefits Deductions Applied' AS ActivityName,
  _add_seconds([PayHistory].[Calculation_Time], 5) AS EventTimestamp,
  'UKG Calc Engine' AS SourceSystem,
  [PayHistory].[Calculation_Time] AS LastUpdateDate,
  'System' AS PayrollSpecialist,
  [PayHistory].[Total_Gross] AS GrossPayAmount,
  [PayHistory].[Department] AS DepartmentCode,
  [PayHistory].[PayGroup] AS PayGroup
FROM [Payroll History Package]
WHERE [PayHistory].[Total_Deductions] > 0

UNION ALL

/* 7. Taxes Calculated */
SELECT
  ([PayHistory].[EmployeeID] + '-' + [PayHistory].[PeriodEndDate]) AS PayrollRecordId,
  'Taxes Calculated' AS ActivityName,
  _add_seconds([PayHistory].[Calculation_Time], 10) AS EventTimestamp,
  'UKG Tax Engine' AS SourceSystem,
  [PayHistory].[Calculation_Time] AS LastUpdateDate,
  'System' AS PayrollSpecialist,
  [PayHistory].[Total_Gross] AS GrossPayAmount,
  [PayHistory].[Department] AS DepartmentCode,
  [PayHistory].[PayGroup] AS PayGroup
FROM [Payroll History Package]
WHERE [PayHistory].[Total_Taxes] > 0

UNION ALL

/* 8. Payroll Result Previewed */
SELECT
  ([AuditLog].[Target_EmployeeID] + '-' + [AuditLog].[Context_Date]) AS PayrollRecordId,
  'Payroll Result Previewed' AS ActivityName,
  [AuditLog].[Access_Time] AS EventTimestamp,
  'UKG Audit' AS SourceSystem,
  [AuditLog].[Access_Time] AS LastUpdateDate,
  [AuditLog].[User_Name] AS PayrollSpecialist,
  0 AS GrossPayAmount,
  [AuditLog].[Department] AS DepartmentCode,
  [AuditLog].[PayGroup] AS PayGroup
FROM [System Audit Package]
WHERE [AuditLog].[Action] = 'View Report' AND [AuditLog].[Report_Name] LIKE '%Pay Register%'

UNION ALL

/* 9. Audit Exception Flagged */
SELECT
  ([PayMessages].[EmployeeID] + '-' + [PayMessages].[PeriodEndDate]) AS PayrollRecordId,
  'Audit Exception Flagged' AS ActivityName,
  [PayMessages].[Message_Time] AS EventTimestamp,
  'UKG Payroll' AS SourceSystem,
  [PayMessages].[Message_Time] AS LastUpdateDate,
  'System' AS PayrollSpecialist,
  0 AS GrossPayAmount,
  [PayMessages].[Department] AS DepartmentCode,
  [PayMessages].[PayGroup] AS PayGroup
FROM [Payroll Messages Package]
WHERE [PayMessages].[Severity] IN ('Warning', 'Error')

UNION ALL

/* 10. Data Correction Performed */
SELECT
  ([AuditData].[EmployeeID] + '-' + [AuditData].[Target_Period_End]) AS PayrollRecordId,
  'Data Correction Performed' AS ActivityName,
  [AuditData].[Change_Time] AS EventTimestamp,
  'UKG Audit' AS SourceSystem,
  [AuditData].[Change_Time] AS LastUpdateDate,
  [AuditData].[User_Changed_By] AS PayrollSpecialist,
  0 AS GrossPayAmount,
  [AuditData].[Department] AS DepartmentCode,
  [AuditData].[PayGroup] AS PayGroup
FROM [Data Audit Package]
WHERE [AuditData].[Table_Name] = 'PayData' AND [AuditData].[Operation] = 'Update'

UNION ALL

/* 11. Payroll Record Approved */
SELECT
  ([PayControl].[EmployeeID] + '-' + [PayControl].[PeriodEndDate]) AS PayrollRecordId,
  'Payroll Record Approved' AS ActivityName,
  [PayControl].[Approval_Time] AS EventTimestamp,
  'UKG Payroll' AS SourceSystem,
  [PayControl].[Approval_Time] AS LastUpdateDate,
  [PayControl].[Approver_ID] AS PayrollSpecialist,
  [PayControl].[Final_Gross] AS GrossPayAmount,
  [PayControl].[Department] AS DepartmentCode,
  [PayControl].[PayGroup] AS PayGroup
FROM [Payroll Control Package]
WHERE [PayControl].[Status] = 'Finalized'

UNION ALL

/* 12. Bank Transfer File Generated */
SELECT
  ([AchFile].[EmployeeID] + '-' + [AchFile].[PeriodEndDate]) AS PayrollRecordId,
  'Bank Transfer File Generated' AS ActivityName,
  [AchFile].[File_Creation_Timestamp] AS EventTimestamp,
  'UKG Banking' AS SourceSystem,
  [AchFile].[File_Creation_Timestamp] AS LastUpdateDate,
  [AchFile].[Generated_By] AS PayrollSpecialist,
  [AchFile].[Net_Pay] AS GrossPayAmount,
  [AchFile].[Department] AS DepartmentCode,
  [AchFile].[PayGroup] AS PayGroup
FROM [Banking / ACH Package]

UNION ALL

/* 13. Payment Executed */
SELECT
  ([CheckRegister].[EmployeeID] + '-' + [CheckRegister].[PeriodEndDate]) AS PayrollRecordId,
  'Payment Executed' AS ActivityName,
  [CheckRegister].[Check_Date] AS EventTimestamp,
  'UKG Payment' AS SourceSystem,
  [CheckRegister].[Check_Date] AS LastUpdateDate,
  'System' AS PayrollSpecialist,
  [CheckRegister].[Gross_Amount] AS GrossPayAmount,
  [CheckRegister].[Department] AS DepartmentCode,
  [CheckRegister].[PayGroup] AS PayGroup
FROM [Check Register Package]

UNION ALL

/* 14. Pay Slip Published */
SELECT
  ([CheckRegister].[EmployeeID] + '-' + [CheckRegister].[PeriodEndDate]) AS PayrollRecordId,
  'Pay Slip Published' AS ActivityName,
  [CheckRegister].[Advice_Available_Date] AS EventTimestamp,
  'UKG Self Service' AS SourceSystem,
  [CheckRegister].[Advice_Available_Date] AS LastUpdateDate,
  'System' AS PayrollSpecialist,
  0 AS GrossPayAmount,
  [CheckRegister].[Department] AS DepartmentCode,
  [CheckRegister].[PayGroup] AS PayGroup
FROM [Check Register Package]
WHERE [CheckRegister].[Is_Void] = 'False'

UNION ALL

/* 15. Tax Filing Completed */
SELECT
  ([TaxHistory].[EmployeeID] + '-' + [TaxHistory].[PeriodEndDate]) AS PayrollRecordId,
  'Tax Filing Completed' AS ActivityName,
  [TaxHistory].[Filing_Submission_Date] AS EventTimestamp,
  'UKG Tax' AS SourceSystem,
  [TaxHistory].[Last_Update] AS LastUpdateDate,
  'System' AS PayrollSpecialist,
  0 AS GrossPayAmount,
  [TaxHistory].[Department] AS DepartmentCode,
  [TaxHistory].[PayGroup] AS PayGroup
FROM [Tax Filing Package]
WHERE [TaxHistory].[Status] = 'Filed'

步骤

前提条件和身份验证：向UKG Pro管理员获取UKG Pro Web Services API凭据，包括Client ID、Client Secret和API Key。确保关联的服务账户具有Payroll和Audit API范围的权限，尤其是/payroll/pay-history/pay-summaries、/payroll/pay-statements和/platform/v1/audit/logs等端点。
配置Python环境：在计算机上安装Python。在终端运行pip install requests pandas，安装发送API请求和处理数据所需的库。
创建Python脚本：将“query”部分提供的Python代码保存为extract_ukg_payroll.py。在同一目录下创建.env文件以安全存储API凭据，或将凭据配置为系统环境变量。
配置脚本参数：打开脚本并修改占位值。将API_BASE_URL设为组织的UKG Pro实例URL。调整START_DATE和END_DATE变量，指定所需的数据提取时间范围，例如最近3至6个月。
运行脚本：在终端中运行命令python extract_ukg_payroll.py。脚本将完成身份验证，从相关UKG Pro端点获取数据，并自动处理分页。
获取和转换数据：脚本首先获取访问令牌，然后在指定日期范围内获取薪资汇总数据和审计日志，并遍历这些记录，生成对应所需活动的事件列表。
生成活动行：对于每条薪资记录，脚本会为15项活动分别生成独立行，并将状态变更、时间戳等API数据字段映射到“Gross Pay Calculated”“Payroll Record Approved”和“Payment Executed”等具体活动。
计算派生属性：生成初始事件日志后，脚本会计算其他属性，包括薪资初始化至付款之间的CycleTimeDays，以及根据付款日期与SLA截止日期设置IsSlaBreached标记。
导出事件日志：脚本将生成的所有事件汇总到pandas DataFrame中，并保存为ukg_payroll_event_log.csv。该文件可直接上传到ProcessMind。
检查并上传：打开生成的CSV文件，检查数据是否完整、准确。确认无误后，将文件上传到ProcessMind项目，开始流程挖掘分析。

配置

前提条件：需要具有API访问权限的UKG Pro服务账户。该账户必须对/payroll/和/platform/v1/audit/范围具有读取权限。
API凭据：请将以下凭据配置为环境变量或直接写入脚本：Client ID、Client Secret、API Key和API主机名（基础URL）。
日期范围：脚本需要配置START_DATE和END_DATE。初次分析建议使用3至6个月的时间范围，以平衡数据量和性能。
筛选：您可以自定义脚本，在API请求URL中按companyId或payGroup等参数筛选，以将提取范围限制在相关员工群体内。
分页处理：脚本会自动处理API分页，确保获取指定日期范围内的所有记录，即使记录数超过单页限制（通常每次调用100条）。
端点依赖：数据提取质量，尤其是审批和更正等工作流活动，主要取决于/platform/v1/audit/logs端点是否可用，以及该端点提供的数据是否完整。请确保UKG Pro实例已启用并配置此端点，以记录相关事件。

查询示例 python

import requests
import pandas as pd
import os
import json
from datetime import datetime, timedelta

class=class="hl-string">"hl-comment"># --- Configuration ---
class=class="hl-string">"hl-comment"># Load credentials from environment variables for security
CLIENT_ID = os.environ.get(class="hl-string">'UKG_CLIENT_ID', class="hl-string">'YOUR_CLIENT_ID')
CLIENT_SECRET = os.environ.get(class="hl-string">'UKG_CLIENT_SECRET', class="hl-string">'YOUR_CLIENT_SECRET')
API_KEY = os.environ.get(class="hl-string">'UKG_API_KEY', class="hl-string">'YOUR_API_KEY')
API_BASE_URL = os.environ.get(class="hl-string">'UKG_BASE_URL', class="hl-string">'https://api.ukg.com') class=class="hl-string">"hl-comment"># Adjust if you have a different base URL

class=class="hl-string">"hl-comment"># Set the desired date range for the extraction
START_DATE = class="hl-string">'2023-01-01T00:00:00Z'
END_DATE = class="hl-string">'2023-06-30T23:59:59Z'

def get_access_token():
    class="hl-string">"""Authenticates with UKG Pro and retrieves a bearer token."""
    auth_url = fclass="hl-string">"{API_BASE_URL}/auth/token"
    headers = {class="hl-string">'Content-Type': class="hl-string">'application/json', class="hl-string">'x-api-key': API_KEY}
    payload = {
        class="hl-string">'grant_type': class="hl-string">'client_credentials',
        class="hl-string">'client_id': CLIENT_ID,
        class="hl-string">'client_secret': CLIENT_SECRET,
        class="hl-string">'scope': class="hl-string">'payroll'
    }
    try:
        response = requests.post(auth_url, headers=headers, data=json.dumps(payload))
        response.raise_for_status()
        return response.json().get(class="hl-string">'access_token')
    except requests.exceptions.RequestException as e:
        print(fclass="hl-string">"Error getting access token: {e}")
        return None

def fetch_paginated_data(url, headers):
    class="hl-string">"""Fetches all pages of data from a UKG Pro API endpoint."""
    all_records = []
    while url:
        try:
            response = requests.get(url, headers=headers)
            response.raise_for_status()
            data = response.json()
            all_records.extend(data)

            class=class="hl-string">"hl-comment"># UKG Pro uses a class="hl-string">'Link' header for pagination
            next_link = response.headers.get(class="hl-string">'Link')
            url = None
            if next_link:
                links = next_link.split(class="hl-string">',')
                for link in links:
                    if class="hl-string">'rel="next"' in link:
                        url = link[link.find(class="hl-string">'<')+1:link.find(class="hl-string">'>')]
                        break
        except requests.exceptions.RequestException as e:
            print(fclass="hl-string">"Error fetching data from {url}: {e}")
            break
    return all_records

def main():
    class="hl-string">"""Main function to extract, transform, and save payroll data."""
    token = get_access_token()
    if not token:
        print(class="hl-string">"Failed to authenticate. Exiting.")
        return

    headers = {
        class="hl-string">'Authorization': fclass="hl-string">'Bearer {token}',
        class="hl-string">'x-api-key': API_KEY
    }

    print(class="hl-string">"Fetching payroll history summaries...")
    class=class="hl-string">"hl-comment"># This endpoint provides core pay calculation and payment data.
    class=class="hl-string">"hl-comment"># We filter by payPeriodEndDate for a relevant time slice.
    pay_history_url = fclass="hl-string">"{API_BASE_URL}/v1/payroll/pay-history/pay-summaries?payPeriodEndDate_from={START_DATE}&payPeriodEndDate_to={END_DATE}&per_page=100"
    pay_records = fetch_paginated_data(pay_history_url, headers)

    class=class="hl-string">"hl-comment"># Note: A comprehensive audit log endpoint is assumed for workflow steps.
    class=class="hl-string">"hl-comment"># The exact endpoint and filter parameters may vary. This is a representative example.
    print(class="hl-string">"Fetching audit log data for workflow events...")
    audit_log_url = fclass="hl-string">"{API_BASE_URL}/platform/v1/audit/logs?startTime={START_DATE}&endTime={END_DATE}&per_page=100"
    audit_logs = fetch_paginated_data(audit_log_url, headers)

    class=class="hl-string">"hl-comment"># Process audit logs into a dictionary for easy lookup
    audit_events_by_record = {}
    for log in audit_logs:
        class=class="hl-string">"hl-comment"># Assumption: The audit log contains a reference to the payroll record ID
        record_id = log.get(class="hl-string">'entityId')
        if record_id:
            if record_id not in audit_events_by_record:
                audit_events_by_record[record_id] = []
            audit_events_by_record[record_id].append(log)

    events = []
    print(fclass="hl-string">"Processing {len(pay_records)} payroll records...")
    for record in pay_records:
        payroll_record_id = fclass="hl-string">"{record.get('employeeId')}-{record.get('payPeriodEndDate')}"
        pay_date = datetime.fromisoformat(record.get(class="hl-string">'checkDate').replace(class="hl-string">'Z', class="hl-string">'+00:00'))
        pay_period_end_date = datetime.fromisoformat(record.get(class="hl-string">'payPeriodEndDate').replace(class="hl-string">'Z', class="hl-string">'+00:00'))
        class=class="hl-string">"hl-comment"># Heuristic: Assume initialization happens 1 day after period end
        initialized_ts = pay_period_end_date + timedelta(days=1)
        class=class="hl-string">"hl-comment"># Heuristic: Assume calculation happens 3 days after period end
        calculated_ts = pay_period_end_date + timedelta(days=3)
        
        class=class="hl-string">"hl-comment"># Use a placeholder for SLA deadline, e.g., 1 day before pay date
        sla_deadline = pay_date - timedelta(days=1)

        common_attributes = {
            class="hl-string">'PayrollRecordId': payroll_record_id,
            class="hl-string">'SourceSystem': class="hl-string">'UKG Pro',
            class="hl-string">'PayrollSpecialist': record.get(class="hl-string">'processingUser', class="hl-string">'System'),
            class="hl-string">'DepartmentCode': record.get(class="hl-string">'department'),
            class="hl-string">'CostCenter': record.get(class="hl-string">'costCenter'),
            class="hl-string">'PayGroup': record.get(class="hl-string">'payGroup'),
            class="hl-string">'GrossPayAmount': record.get(class="hl-string">'grossEarnings'),
            class="hl-string">'TaxJurisdiction': record.get(class="hl-string">'primaryTaxState'),
            class="hl-string">'SlaProcessingDeadline': sla_deadline.isoformat(),
            class="hl-string">'IsOffCycle': record.get(class="hl-string">'isOffCycle', False),
            class="hl-string">'PayPeriodEndDate': pay_period_end_date.isoformat(),
            class="hl-string">'HasAuditException': False, class=class="hl-string">"hl-comment"># To be updated by audit events
        }

        class=class="hl-string">"hl-comment"># 1. Time Sheet Submitted (from audit)
        class=class="hl-string">"hl-comment"># 2. Time Sheet Approved (from audit)
        class=class="hl-string">"hl-comment"># These events are highly dependent on audit log content. Using placeholders.
        events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Time Sheet Submitted', class="hl-string">'EventTimestamp': (initialized_ts - timedelta(hours=12)).isoformat()})
        events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Time Sheet Approved', class="hl-string">'EventTimestamp': (initialized_ts - timedelta(hours=6)).isoformat()})

        class=class="hl-string">"hl-comment"># 3. Payroll Record Initialized
        events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Payroll Record Initialized', class="hl-string">'EventTimestamp': initialized_ts.isoformat()})

        class=class="hl-string">"hl-comment"># 4. Incentive Data Imported (from audit)
        events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Incentive Data Imported', class="hl-string">'EventTimestamp': (initialized_ts + timedelta(days=1)).isoformat()})

        class=class="hl-string">"hl-comment"># 5-7. Calculation Steps
        events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Gross Pay Calculated', class="hl-string">'EventTimestamp': calculated_ts.isoformat()})
        events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Benefits Deductions Applied', class="hl-string">'EventTimestamp': (calculated_ts + timedelta(seconds=10)).isoformat()})
        events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Taxes Calculated', class="hl-string">'EventTimestamp': (calculated_ts + timedelta(seconds=20)).isoformat()})

        class=class="hl-string">"hl-comment"># 8. Payroll Result Previewed (from audit)
        events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Payroll Result Previewed', class="hl-string">'EventTimestamp': (calculated_ts + timedelta(hours=1)).isoformat()})

        class=class="hl-string">"hl-comment"># 9-10. Audit/Correction Events (from audit log)
        record_audits = audit_events_by_record.get(payroll_record_id, [])
        for audit_event in record_audits:
            event_ts = audit_event.get(class="hl-string">'eventDateTime')
            if class="hl-string">'Exception' in audit_event.get(class="hl-string">'eventName', class="hl-string">''):
                events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Audit Exception Flagged', class="hl-string">'EventTimestamp': event_ts, class="hl-string">'HasAuditException': True})
            if class="hl-string">'Correction' in audit_event.get(class="hl-string">'eventName', class="hl-string">''):
                events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Data Correction Performed', class="hl-string">'EventTimestamp': event_ts})

        class=class="hl-string">"hl-comment"># 11. Payroll Record Approved
        class=class="hl-string">"hl-comment"># Heuristic: Approval happens 2 days before pay date
        approved_ts = pay_date - timedelta(days=2)
        events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Payroll Record Approved', class="hl-string">'EventTimestamp': approved_ts.isoformat()})

        class=class="hl-string">"hl-comment"># 12. Bank Transfer File Generated
        class=class="hl-string">"hl-comment"># Heuristic: File is generated the day before pay date
        bank_file_ts = pay_date - timedelta(days=1, hours=4)
        events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Bank Transfer File Generated', class="hl-string">'EventTimestamp': bank_file_ts.isoformat()})
        
        class=class="hl-string">"hl-comment"># 13. Payment Executed
        events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Payment Executed', class="hl-string">'EventTimestamp': pay_date.isoformat()})

        class=class="hl-string">"hl-comment"># 14. Pay Slip Published
        class=class="hl-string">"hl-comment"># Assumption: Published on the pay date
        events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Pay Slip Published', class="hl-string">'EventTimestamp': (pay_date + timedelta(hours=8)).isoformat()})

        class=class="hl-string">"hl-comment"># 15. Tax Filing Completed
        class=class="hl-string">"hl-comment"># Heuristic: Filing completed 2 days after pay date
        tax_filed_ts = pay_date + timedelta(days=2)
        events.append({**common_attributes, class="hl-string">'ActivityName': class="hl-string">'Tax Filing Completed', class="hl-string">'EventTimestamp': tax_filed_ts.isoformat()})

    if not events:
        print(class="hl-string">"No events generated. Check API response or date range.")
        return

    class=class="hl-string">"hl-comment"># Create DataFrame and add final attributes
    df = pd.DataFrame(events)
    df[class="hl-string">'EventTimestamp'] = pd.to_datetime(df[class="hl-string">'EventTimestamp'])
    df = df.sort_values(by=[class="hl-string">'PayrollRecordId', class="hl-string">'EventTimestamp']).reset_index(drop=True)

    df[class="hl-string">'LastUpdateDate'] = datetime.now().isoformat()

    class=class="hl-string">"hl-comment"># Calculate cycle time and SLA breach
    start_times = df[df[class="hl-string">'ActivityName'] == class="hl-string">'Payroll Record Initialized'][[class="hl-string">'PayrollRecordId', class="hl-string">'EventTimestamp']].rename(columns={class="hl-string">'EventTimestamp': class="hl-string">'StartTime'})
    end_times = df[df[class="hl-string">'ActivityName'] == class="hl-string">'Payment Executed'][[class="hl-string">'PayrollRecordId', class="hl-string">'EventTimestamp']].rename(columns={class="hl-string">'EventTimestamp': class="hl-string">'EndTime'})
    sla_deadlines = df[[class="hl-string">'PayrollRecordId', class="hl-string">'SlaProcessingDeadline']].drop_duplicates()

    df = df.merge(start_times, on=class="hl-string">'PayrollRecordId', how=class="hl-string">'left')
    df = df.merge(end_times, on=class="hl-string">'PayrollRecordId', how=class="hl-string">'left')
    df = df.merge(sla_deadlines, on=class="hl-string">'PayrollRecordId', how=class="hl-string">'left')

    df[class="hl-string">'CycleTimeDays'] = (df[class="hl-string">'EndTime'] - df[class="hl-string">'StartTime']).dt.total_seconds() / (24 * 3600)
    df[class="hl-string">'IsSlaBreached'] = df[class="hl-string">'EndTime'] > pd.to_datetime(df[class="hl-string">'SlaProcessingDeadline'])
    
    df.drop(columns=[class="hl-string">'StartTime', class="hl-string">'EndTime'], inplace=True)

    class=class="hl-string">"hl-comment"># Reorder columns to match requirements
    final_columns = [
        class="hl-string">'PayrollRecordId', class="hl-string">'ActivityName', class="hl-string">'EventTimestamp', class="hl-string">'SourceSystem', class="hl-string">'LastUpdateDate',
        class="hl-string">'PayrollSpecialist', class="hl-string">'DepartmentCode', class="hl-string">'CostCenter', class="hl-string">'PayGroup', class="hl-string">'GrossPayAmount',
        class="hl-string">'TaxJurisdiction', class="hl-string">'SlaProcessingDeadline', class="hl-string">'IsOffCycle', class="hl-string">'HasAuditException',
        class="hl-string">'PayPeriodEndDate', class="hl-string">'IsSlaBreached', class="hl-string">'CycleTimeDays'
    ]
    df = df[final_columns]

    class=class="hl-string">"hl-comment"># Save to CSV
    output_filename = class="hl-string">'ukg_payroll_event_log.csv'
    df.to_csv(output_filename, index=False, date_format=class="hl-string">'%Y-%m-%dT%H:%M:%S.%fZ')
    print(fclass="hl-string">"Extraction complete. Event log saved to {output_filename}")

if __name__ == class="hl-string">'__main__':
    main()

准备好开始了吗？

使用此模板将UKG Pro原始数据转换为可视化流程图。如果您需要为复杂的薪资环境配置数据提取，我们的支持团队可以提供帮助。

返回改进指南

下载模板

立即优化UKG Pro薪资处理流程

将薪资周期时间缩短30%，消除瓶颈。

开始免费试用

无需信用卡，5分钟即可完成设置

薪资处理数据模板

薪资处理数据模板

薪资处理属性

薪资处理活动

数据提取指南

导出UKG Pro商业智能报告

步骤

配置

查询示例 sql

通过UKG Pro Web Services API和Python提取数据

步骤

配置

查询示例 python

准备好开始了吗？

立即优化UKG Pro薪资处理流程