Wrappers and Pipelines

Data Hub is implemented with default wrappers and the pipelines they contain. Pipeline settings are populated with default values. These settings can be edited from the Pipeline Settings page. You can also add an override profile to modify the default values. See Wrapper Override Profiles.

Pipeline names reflect their functionality within the context of their wrapper. For example, the wrapper ESS (employee self-service) contains a pipeline named essTimeOff. This pipeline accesses tables in BigQuery associated with data such as time off approval history, approval period, request periods Defines a time span during which shifts can be changed by an approved request., and change status. For a list of pipeline settings, see Pipeline Settings.

Wrappers are used to run pipelines in logical groupings and sequences. Initial loads are historical and subsequent loads are incremental. For a list of pipelines and their sequences for each default wrapper, see Appendix A - Wrapper Pipelines and Sequences.

Wrappers and pipelines are released for use in Data Hub Configuration Portal in one of three stages:

  • Beta. Recently introduced wrappers and pipelines not yet released in the product. Made available to a limited set of customers for use in a production environment. Beta pipelines are not added to default wrappers but can be used in wrapper override profiles. Their data structures are tested and supported on a “best effort” basis but are subject to change. Tenant-specific pipeline settings and wrapper override assignments are not guaranteed to persist the transition to limited or general availability. Beta wrapper and pipeline names are appended with (Beta). For example, Budgeting_Retail(Beta).
  • Limited Availability. Recently introduced in the product, these wrappers and pipelines are made available to a limited set of customers for use in a production environment as described in this guide. Limited availability wrappers and pipelines are fully tested and supported. Wrapper and pipeline names are appended with (Limited Availability). For example, getPayPeriod(Limited Availability).
  • General Availability. These wrappers and pipelines are available in the product to all customers for use in a production environment as described in this guide. General Availability wrappers and pipelines are fully tested and supported. Because General Availability wrappers and pipelines are the most common, their names are not appended.

Note: In most cases, beta and limited availability wrappers and pipelines are subsequently released for general availability.

Run Data Hub wrappers based on how frequently the source data changes. The following table describes the default wrappers included in the Data Hub deployment.

Wrapper Description Default (Recommended) Frequency
Accruals Executes the accrual transaction, accrual balances, accrual codes, business structure, and people pipelines. Daily or Weekly as Needed
Auditing Loads the schedule audits. Daily
Budgeting Retail Executes the labor budget, volume budget, and summary pipelines. As Needed
Core Executes pipelines necessary for timekeeping and scheduling data. Pipelines include People, Business Structure Represents the logical structure of an organization as it concerns staffing. It contains the locations and jobs to which an employee may be assigned., schedule, timecard, timecard metrics Measures and tracks workforce performance by comparing planned with actual workload or coverage, or by showing variances at any organizational level., summary, and so on. Daily
ESS Executes employee self-service pipelines and captures data about employee self-service requests. Daily
Forecasting Retail Executes the volume forecast, labor forecast, and summary pipelines. Weekly
Healthcare Productivity Healthcare Productivity allows managers to analyze payroll, volume, and daily labor data so that they can make informed budget and schedule decisions based on metrics for the actual volume, the core scheduling plan, and staffing decisions. Previously, Healthcare Productivity (HCP) was called Healthcare Analytics (HCA). Executes Healthcare Productivity work units, payroll detail, daily and pay period productivity pipelines. Daily
Summary Executes the summary pipeline. Daily
SummaryIntra Populates the metrics and attributes in vKronosIntraSummary, which contains data at the 15-minute grain. As Needed
Volume Actuals Retail Executes the volume actuals and summary pipelines. Daily
Workload Planner Tracks and edits staffing plans that define the number of workers that are needed for each shift or schedule zone and job. Loads volume, workload Specifies a number of employees needed for a certain job at a certain location over a certain span of time., weight set, and planned scheduled coverage pipelines. Daily