Home
Data Dictionary entities
A
Actual Volume Detail
The Actual Volume Detail entity provides actual volume data. You should always use this entity along with the Actual Volumeentity and either the Actual Volume Detail Schedule Zoneor the Actual Volume Detail Standard Shiftentity. Using them together will provide data in a schedule period for actual volume values by date, by location (above Job) in the Business Structure, and by either schedule zone or shift sets.

Data Dictionary entities
- A
  - Absence Exceptions
    The Absence Exceptions entity provides the data columns that that indicate when an employee has had an Excused Absence or Unexcused Absence exception during the selected time period. The data columns return a True or False value to indicate if the exception has occurred. A True value is rendered as a check mark and a False value as an empty cell.
  - Absence Exceptions with Assignment
    The Absence Exceptions with Assignments entity provides the data columns that that indicate when an employee has had an Excused Absence or Unexcused Absence exception during the selected time period and multiple assignments were in use. The data columns return a True or False value to indicate if the exception has occurred. A True value is rendered as a check mark and a False value as an empty cell.
  - Accrual Balances by Day
    The Accrual Balances by Day entity allows an administrator to create a Dataview or report data object that lists accrual balances for all accrual codes or for a selected accrual code. The Accrual Balances by Day entity is a replica of the Accrual Daily Balancesentity but, instead of providing the balance data as of the end date of the defined time period, the Accrual Balances by Day entity provides the balance data for each day in the selected time period.
  - Accrual Code
    Use the Accrual Code entity to create Dataviews and reports that include accrual balances and transactions. It provides the data columns that display the accrual code related to a balance or transaction, as well as all of the attributes of that accrual code, such as its name and type (hours, money, or day).
  - Accrual Daily Balances
    The Accrual Daily Balances entity provides the available, vested, and probationary accrual balances for each unique employee and accrual code combination. This information includes the current available accrual balance which factors in future planned takings. In addition, the Accrual Daily Balances entity provides data columns that show the accruals that the employee has earned to date and taken to date, as well as its pending grants and planned takings.
  - Accrual Daily Balances
    The Accrual Daily Balances entity provides the available, vested, and probationary accrual balances for each unique employee and accrual code combination. This information includes the current available accrual balance which factors in future planned takings. In addition, the Accrual Daily Balances entity provides data columns that show the accruals that the employee has earned to date and taken to date, as well as its pending grants and planned takings.
  - Accrual Daily Balances No CT
    The Accrual Daily Balances No CT entity provides the available, vested, and probationary accrual balances for each unique employee and accrual code combination. This entity provides similar data as the Accrual Daily Balancesentity, but for this entity No callable totalization (CT) occurs so that totalized data loads faster.
  - Accrual Reporting Period Balances
    The Accrual Reporting Period Balances entity provides accrual balance data based on the defined accrual reporting period for each defined accrual code. This information includes the vested and probationary balances for the beginning and end of the accrual reporting period that is associated with the accrual code, including the ending balance for the previous reporting period.
  - Accrual Transactions
    The Accrual Transactions entity provides data for all accrual transactions by employee, accrual code, and accrual transaction type (such as takings, grants, and probation period start).
  - Activity
    The Activity entity is intended to be used with the Activity transactional entities. It contains a large number of properties that fully describe the activity definition and contain status information. All activity status attributes are available in this entity.
  - Activity Audit
    The Activity Audit entity records all new activity segments in addition to any updates that were done to the segment, including who modified it and when it was modified.
  - Activity Efficiency
    The Activity Segment Efficiency entity shows the efficiency of the activity segment based on the allocated, earned hours and quantity. Two types of efficiency are calculated.
  - Activity Employee
    The Activity Employee entity can be used in Dataviews and reports, along with columns from the Employee Detailsentity, to return the name of the activity to which an employee is assigned.
  - Activity Failed Forms
    The Activity Failed Forms entity records failed transactions from clocks during their offline mode. When clocks lose connectivity to the server, this entity continues to record all activity transactions at the clock without interaction with the server. When the clock regains connectivity, the clock sends all of the saved transactions to the server. Any errors that prevent the activity from being stored in the main table can be viewed in this entity.
  - Activity Paycode Totals
    Each activity segment that employees perform is analyzed by the Background Processor to determine such values as the number of allocated hours and cost. These values are available in the Activity Paycode Totals entity.
  - Activity Segment Efficiency
    The Activity Segment Efficiency entity shows the efficiency of the activity segment based on the allocated, earned hours and quantity. Two types of efficiency are calculated.
  - Activity Team
  - Actual & Schedule Shift Times
    The Actual & Schedule Shift Times entity allows users to create a Dataview or report that lists the actual and scheduled punch times for all shifts for all employees returned as a single row for each shift assigned to an employee. The Actual Shift Start and Actual Shift End columns will include projected punches for Pay From Schedule employees.
  - Actual Paycode Totals Corrections Only
    The Actual Paycode Totals Corrections Only provides the total hours, wages, or days related to a historical correction made during the selected time period for a selected pay code. When creating a Dataview, you can select the pay code for which totals data will be provided. For example, to create a Dataview that shows the hours for each employee that are related to the "REGULAR" pay code and that were generated by a historical correction performed in the selected time period, configure the Paycode Total Actual Hours (Corrections Only) data column with an assignment value of "REGULAR."
  - Actual Paycode Totals Exclude Corrections
    The Actual Paycode Totals Exclude Corrections entity provides the total hours, wages, or days that are related to the selected time period for a selected pay code, minus any historical correction totals related to the selected time period. When creating a Dataview, you can select the pay code for which totals data will be provided. For example, to create a Dataview that shows the hours for each employee that are related to the "REGULAR" pay code that apply to the selected time period (excluding historical corrections made in that period), configure the Paycode Total Actual Hours (Exclude Corrections) data column with an assignment value of "REGULAR".
  - Actual Paycode Totals Include Corrections
    The Actual Paycode Totals Include Corrections entity provides the total hours, wages, or days that are related to the selected time period for a selected pay code, including any historical correction totals related to the selected time period. When creating a Dataview, you can select the pay code for which totals data will be provided. For example, to create a Dataview that shows the hours for each employee related to the "REGULAR" pay code that apply to the selected time period (including historical corrections made in that period), configure the Paycode Total Actual Hours (Include Corrections) data column with an assignment value of "REGULAR".
  - Actual Totals Corrections Only
    The Actual Totals Corrections Only entity provides the total hours, wages, or days that are related to all historical correction transactions that were performed in the selected time period. When creating a Dataview, you can define how the totals data is summarized by selecting the desired parameter value from the following:
  - Actual Totals Exclude Corrections
    The Actual Totals Exclude Corrections entity provides the total hours, wages, or days related to the selected time period for all transactions performed in the selected time period excluding historical corrections. When creating a Dataview, you can define how the totals data is summarized by selecting the desired parameter value from the following:
  - Actual Totals Include Corrections
    The Actual Totals Include Corrections entity provides the total hours, wages, or days related to the selected time period for all transactions performed in the selected time period including historical corrections. When creating a Dataview, you can define how the totals data is summarized by selecting the desired parameter value from the following:
  - Actual Volume
    The Actual Volume entity provides two columns, actual volume date and version, which provide the date and version of the actual volume data that has been entered in or imported to Workload Planner. Always use the Actual Volume entity in conjunction with the Actual Volume Detailentity and either the Actual Volume Detail — Schedule Zoneor Actual Volume Detail — Standard Shiftentity. Using data columns from these entities together will provide actual volume data by date, location (above Job) in the Business Structure, and schedule zone or shift set.
  - Actual Volume – Schedule Zone
    The Actual Volume – Schedule Zone entity provides the schedule zone details for the actual volume data that is present in Workload Planner. Because the Actual Volume – Schedule Zone entity does not have a relationship with the Actual Volume Detail entity that stores the actual volume value, it is recommended that you use the Actual Volume Detail – Schedule Zoneentity instead. Both entities provide the same information.
  - Actual Volume – Schedule Zone Set
    The Actual Volume – Schedule Zone Set entity provides the schedule zone set that is assigned to a location in the workload set up.
  - Actual Volume – Standard Shift
    The Actual Volume – Standard Shift entity provides the standard shifts for the actual volume data that is present in Workload Planner.
  - Actual Volume – Standard Shift Set
    The Actual Volume – Standard Shift Set entity provides the standard shift set that is assigned to a location in the Business Structure.
  - Actual Volume Detail
    The Actual Volume Detail entity provides actual volume data. You should always use this entity along with the Actual Volumeentity and either the Actual Volume Detail Schedule Zoneor the Actual Volume Detail Standard Shiftentity. Using them together will provide data in a schedule period for actual volume values by date, by location (above Job) in the Business Structure, and by either schedule zone or shift sets.
  - Actual Volume Detail – Schedule Zone
    The Actual Volume Detail – Schedule Zone entity provides the zone details for the actual volume data that is present in Workload Planner. These can be analyzed by location (above Job) in the Business Structure.
  - Actual Volume Detail – Standard Shift
    The Actual Volume Detail – Standard Shift entity provides the standard shift details for the actual volume data that is created in Workload Planner. These can be analyzed by location (above Job) in the Business Structure. (Volume is not created at the Job level.)
  - Analytics
    The Analytics entity provides the metrics and KPIs that are defined in the product and those metrics and KPIs that are custom-defined. The metrics and KPIs provide a means to measure labor management performance in areas like overtime, absenteeism, and productivity. Use the data columns in Employee Dataviews and reports to measure and compare individual employee performance or in Business Structure Dataviews and reports to measure and compare organizational entities, such as job, department, region, or location.
  - Approval Summary
    The Approval Summary entity provides the data columns that are necessary to understand the status of an employee’s timecard approval, indicating for a period of time whether the timecard has been approved by the manager or employee.
  - Approval Transactions
    The Approval Transactions entity provides data columns about each timecard approval transaction, including who approved the transaction (manager or employee), if the approval was applied to the timecard, and when the timecard was approved.
  - Approvals Reviewers
    The Approvals Reviewers entity provides the information related to each employee's overtime approval level, settings, and assigned approvers.
  - Assignment
  - Attendance Actions Summary
    The Attendance Actions Summary entity provides the data columns that are necessary to view data related to the most recent Attendance action associated with employees for the defined time period. You can create a Dataview that shows the action that was triggered by the Attendance application and all details related to that action, such as the date on which it was triggered, the date on which it was completed, the status of the action, and the balance associated with it.
  - Attendance Transactions
    The Attendance Transactions entity exposes the transactional data generated by the Attendance application. The Attendance Transactions entity exposes the transactional data generated by the Attendance application.
  - Attestation Daily Detail
    The Attestation Daily Detail entity provides data related to the questions asked and responses that an employee submitted when attesting to punches, totals, and breaks. Using this information, a manager can see how employees are answering the questions that were posed to them and the time required for a response.
  - Audit
    The Audit entity provides data related to timecard transactions, including the addition, edit, or removal of punches, paycode edits, comments, and leave edits. The data columns allow for the creation of Dataviews and reports that provide the data available through the Audit add-on that is visible in the timecard.
  - Audit Attendance
    The Audit Attendance entity provides data related to Attendance transactions of all types (such as Events, Balance Adjustments, and Actions). The data columns allow for the creation of Dataviews and reports that allow managers to clearly audit the use of the Attendance application by their employees.
  - Audit Availability
    The ability to create Dataviews and reports that provide detailed audit information related to the adding, editing, or deleting of the availability of employees requires the use of data columns from four different entities in the Data Dictionary: Audit Availability, Schedule Availability, Schedule Segment Availability, and Availability Type.
  - Audit Availability
    The ability to create Dataviews and reports that provide detailed audit information related to the adding, editing, or deleting of the availability of employees requires the use of data columns from four different entities in the Data Dictionary: Audit Availability, Schedule Availability, Schedule Segment Availability, and Availability Type.
  - Audit Employee Preferences
  - Audit Forecasting
    The Audit Forecasting entity provides columns for use in a Dataview or report that return audit data for a given Forecasting entity type.
  - Audit Leave
    The Audit Leave entity provides data related to Leave transactions, including the creation, editing, and removal of leave cases and associated documents. The data columns allow for the creation of Dataviews and reports that allow managers to clearly audit the use of the Leave application by their employees.
  - Audit Schedule
    The Audit Schedule entity provides data that enables you to create Dataviews and reports that can be used to examine all schedule audits for a location or a group of employees. It also provides information that can help determine how many schedule edits managers are making, which employee schedules are being edited, and which managers are making those edits.
  - Audit Schedule
    The Audit Schedule entity provides data that enables you to create Dataviews and reports that can be used to examine all schedule audits for a location or a group of employees. It also provides information that can help determine how many schedule edits managers are making, which employee schedules are being edited, and which managers are making those edits.
  - Audit Timekeeping
    The Audit Timekeeping entity provides data related specifically to punch transactions, including the addition, editing, and removal of punches, punch comments, and notes. The data columns allow for the creation of Dataviews and reports that allow managers to clearly audit modifications to employee punches.
  - Auditor Count (Month)
    The Auditor Count (Month) entity provides data related to timecard transactions for the current month, including the addition, edit, or removal of meals, punches, paycode edits, and exceptions. It also provides the change in the Auditor Count from the previous month to the current month as a percentage.
  - Auditor Pattern Strength
  - Auditor Rate (Month)
  - Availability Pattern Request Detail
    The Availability Pattern Request Detail entity makes data available to Dataviews and Report Data Objects that allow managers to review the availability pattern change requests made by employees. This allows manager to better understand the number of requests, the employees making those requests, and the status of those requests. With this information, managers can better ensure that availability pattern requests are being approved or rejected in a timely manner, which employees are regularly requesting availability pattern changes, and which are not.
  - Availability Request Detail
    The Availability Request Detail entity provides data that enables you to create Dataviews and reports that can be used to review availability requests that are made by employees. This data allows you to determine the number of requests, which employees are making the requests, and the status of the requests. Given this information managers can better ensure that availability requests are being approved or rejected in a timely manner and learn which employees are or are not regularly requesting availability changes.
  - Availability Request Status History
    The Availability Request Status History entity allows a user to see the path that a request for availability has taken through the approval process, such as who has changed the status of a request and when that status was changed.
  - Availability Type
    The Availability Type entity provides a single data column for use when creating a Dataview or report that provides audit information related to Availability. The Availability Type data column provides the type of availability related to a specific schedule segment (Available, Unavailable, Preferred, or Preferred Time Off). For more information on analyzing Availability audit data, see the Audit Availabilityentity.
  - Average Worked Hours
    The Average Worked Hours entity provides the data columns that are necessary to measure the average number of hours worked by employees per week. This data allows managers to understand if employees who are designated as full-time or part-time" are actually working the appropriate number of hours on average over a defined period of time.
- B
- C
- E
- Employee HCM
- F
- G
- H
- Healthcare Analytics Data Entities
- J
- K
- L
- M
- N
- O
- P
- R
- S
- T
- V
- W

Actual Volume Detail

The Actual Volume Detail entity provides actual volume data. You should always use this entity along with the Actual Volumeentity and either the Actual Volume Detail Schedule Zoneor the Actual Volume Detail Standard Shiftentity. Using them together will provide data in a schedule period for actual volume values by date, by location (above Job) in the Business Structure, and by either schedule zone or shift sets.

Supported Dataview types

Employee Dataview	Business Structure Dataview
	X

Data granularity

Provides one row per location (above Job) in the Business Structure, per date, per schedule zone or shift set.

Columns

Label	Key
Actual Volume Parent ID	SCH_ACTUAL_VOLUME_DETAIL_PARENT_ID
Actual Volume Plan Type	SCH_ACTUAL_VOLUME_DETAIL_PLAN_TYPE
Actual Volume Value	SCH_ACTUAL_VOLUME_DETAIL_VALUE
Actual Weighted Volume	SCH_ACTUAL_VOLUME_DETAIL_WEIGHTED_VOLUME_AMOUNT

Related entities

Actual Volume
Actual Volume - Schedule Zone Set
Actual Volume - Standard Shift Set
Actual Volume Detail – Schedule Zone(child entity)
Actual Volume Detail – Standard Shift(child entity)
Budget Volume
Budget Volume Detail(Column relationship rules must be disabled.)
Location
Plan Volume
Plan Volume Detail(Column relationship rules must be disabled.)

Additional information

Actual Volume Detail data cannot be analyzed only by department or only by department and date because the current data model does not support aggregation at those levels. The actual volume detail data can be analyzed only by department, span (zone or shift name), and date. This is the granularity at which the data is provided.
The volume data cannot be correlated with coverage scheduled count data, workload planned count data, or workload budgeted count data because:
- The volume data is not present at the Job level.
- The workload count or coverage scheduled count data cannot be aggregated for location types above Job in the Business Structure.
If you plan to create a Dataview or report data object using plan volume detail, actual volume detail, and budget volume detail together, you must disable the column relationship rules.

Core entity

Employee	Organization	Day	Organizational Job	Paycode	Labor Category
	X

Relationship

One-to-One	One-to-Many
	X