Professional Documents
Culture Documents
Expanding Reports Using The Dataset Builder - Training Guide 590301
Expanding Reports Using The Dataset Builder - Training Guide 590301
Expanding Reports Using The Dataset Builder - Training Guide 590301
Dataset Builder
Training Guide
Training Guide Icons
Icon Use
Tip
Question or problem for the student to think about and the class to discuss.
590301
Contents
Course Overview ................................................................................................................................ 4
Learning Objectives....................................................................................................................................... 4
Prerequisites ................................................................................................................................................. 4
Available Resources ...................................................................................................................................... 5
Our Training Scenario ................................................................................................................................... 5
Reporting Functionality Review .......................................................................................................... 6
Reporting Feature and Terminology Review ................................................................................................ 6
Security ......................................................................................................................................................... 7
Topics ............................................................................................................................................................ 8
How to Identify Topics Types ................................................................................................................. 8
Dataset Builder ............................................................................................................................................. 9
Relationships Editor.............................................................................................................................. 10
Identifying Modified Topics in Report Designer................................................................................... 11
Updating V2 Topics .......................................................................................................................... 12
Query Entities ............................................................................................................................................. 12
Relationships ............................................................................................................................................... 15
Keys ...................................................................................................................................................... 15
Query Entity Options ............................................................................................................................ 16
Joins ...................................................................................................................................................... 18
Record Conditions ................................................................................................................................ 23
Parameters and Filters ......................................................................................................................... 24
Filters........................................................................................................................................................... 26
Effective Dating .................................................................................................................................... 26
Optional Activities ........................................................................................................................... 31
Create a Report from a Blank Dataset ........................................................................................................ 31
Adding Query Entities ........................................................................................................................... 32
Add Related Query Entities .................................................................................................................. 33
Create ................................................................................................................................................... 34
Parameters ........................................................................................................................................... 34
Set Record Conditions .......................................................................................................................... 34
Use .............................................................................................................................................................. 36
Alias (Copy) Query Entities.......................................................................................................................... 36
4 Expanding Reporting Power Using the Dataset Builder
Course Overview
Welcome to Expanding Reporting Using the Dataset Builder. This course is intended for HRIS or other
HR, payroll, WFM, and Talent professionals who are experienced report designers. In this course, you
will discover how to use the Dataset Builder. Dataset Builder allows you to choose fields outside of the
topic by dynamically building the relationships to those fields within the Report Designer.
The following sections are included in this course:
Section Description
Reporting Functionality Overview Discuss terminology, topic version, security and the
available guides.
Updating V2 Topics Learn to add and remove query entities in reports
that are based on V2 topics. Understand and work
with query entities, relationships, and parameters.
Optional Activities Time permitting, learn to start a report with a blank
dataset by selecting a primary query entity and
joining other query entities. Also, learn to use alias
query entities.
Learning Objectives
By completing this course, you will be able to:
• Identify topic type
• Understand query entity relationships and join types
• Comprehend record conditions
• Create relationships
• Use effective dating
• Create a report with a new dataset
Prerequisites
Certain Dayforce courses are required as prerequisites prior to attending this course. The following
courses will provide the foundational knowledge you need to understand the key Dayforce features
discussed in this course.
Available Resources
A variety of supporting guides are available through the Ceridian Support Portal (support.ceridian.com)
using the Knowledge Articles search feature. Talk to your organization’s support user or Implementation
Consultant to obtain these guides.
Feature Description
Report Designer Tool that allows you to create and edit reports.
Dataset Builder Feature within Report Designer that allows you to create relationships to
fields outside of the report topic, allowing you to expand the dataset.
Reports Sub-area where you can access report templates, schedule reports and
create or edit reports in Report Designer.
Report Category Sub-area where you can organize reports and allocate where they are
viewable in Dayforce features.
Users create data in Dayforce through their daily processes, like hiring employees, processing time
sheets, giving raises, and running payroll. That data is stored in the database. You may need to access
that data in a way that is meaningful to your organization. Therefore, you need a method to access that
data and format it in a way that helps you to understand the data and make decisions.
Queries are used to access the data you need. A query is a request for information from a database that
identifies what data you want returned. The fields that are returned are the dataset. The dataset may
have much more information than you need in any one report. The report that uses the dataset is then
organized and formatted to deliver the data and format that you need. Dayforce comes with fixed
format reports, report templates, and predefined topics that address commonly requested information.
Optionally, within the Report Designer, you can use the Dataset Builder when the other Dayforce
reporting solutions cannot provide the results that you want, and you need to bring in related data from
outside of a topic or create a new dataset.
Security
To access the Dataset Builder within the Report Designer, check the Dataset Builder child-feature under
Reporting > Report Designer. Otherwise, the Dataset Builder will be disabled.
8 Reporting Functionality Review Expanding Reporting Power Using the Dataset Builder
Topics
Topics are preconfigured datasets in Reporting. Topics can be used as the starting point for templates
and new reports. The two types of topics used in reports are V1 (Version1) and V2 (Version2). Each
version uses different technologies to create the underlying query.
Dataset builder is only available in V2 Topics. V2 Topics were created within Dayforce. This allows you to
modify the topic by bringing in new data via the Dataset Builder. Additionally, Dataset Builder assists you
by creating relationships between the query entities, which are like SQL tables. We will discuss query
entities later in the course. It’s a best practice to create reports that are based on V2 Topics.
You can find the Reporting Reference Guide on the Ceridian Support Portal.
Additionally, each report and report template within Reports will display the corresponding Topic Type.
Not all topics have templates, so this is not a complete list. The example below displays how to view the
Topic Type in Reports.
Dataset Builder
In Dayforce, we will define a dataset as collection of related fields and query entities. Query entities are
logically grouped data and are used like tables inside the Report Designer.
Dataset Builder allows you to update V2 topics by bringing in new query entities and fields from outside
of the Dayforce predefined topics. Dataset Builder also allows you to start with a blank dataset and add
query entities that provide the dataset that you desire. These datasets are built by joining query entities.
It is a best practice to update an existing V2 topic. When you want to expand an existing V2 topic, you
can use the Dataset Builder to bring in fields from query entities outside the topic into your current
report. This allows you to expand your dataset dynamically within Report Designer. Dataset Builder is
composed of two features within the Report Designer tool bar, Add Field and Relationships. If creating a
report from a blank dataset, you will start with Add Reports from the Reports toolbar.
For reports or templates based on V2 topics, click Add Field in the Fields list on the Report Designer
toolbar.
This opens the Add Field dialog box. You are required to choose one or more selections from the
Categories list. You can also use the Keyword search to further refine the results. The Related Entity
Filter list allows you to find paths that start with the selected entry. Also, you can filter by the number of
joins indicated the number of Relationship Levels that you select. Click Apply, you will see a list of query
entities that you can choose to insert into your report. Select the query entity that is appropriate to the
data that you need and click OK to confirm your choice.
10 Reporting Functionality Review Expanding Reporting Power Using the Dataset Builder
In this example, choosing the Category “Organization,” the Keyword “site,” the Related Entity Filter
“Employee Work Assignment,” and selecting up to two Relationship Levels returns the Location
Hierarchy query entity. We will discuss how entities are related later in this course.
Relationships Editor
The Relationship Editor allows you to view the query entity relationships within the topic. If you select a
field outside of the topic in the Add Field dialog box, you can verify the new relationship, change the
relationship and add new conditions here. We will discuss more details about relationships and options
later in the course.
Throughout the Reporting feature, on-line help is available by clicking the “i” icon. The contents of the
help feature will change according to where you are within the Reporting feature.
In this example, by clicking on the “i” by the Join Type, a new window with Tips for Report Writing
appears.
12 Updating V2 Topics Expanding Reporting Power Using the Dataset Builder
Updating V2 Topics
While you can start a report from a blank dataset, the best practice in Dayforce will be to update a V2
topic. To do that, an understanding of the components of the topics will allow you to understand the
dataset returned when that topic is used. The advantage of using a V2 topic when creating your report is
that you can use the Dataset Builder to expand your dataset by retrieving fields outside of the topic.
The components of the topic include the following:
Feature Description
Query Composed of a group of related fields and are similar to tables or views in a
Entities relational database
Relationships Defines the relationships or joins between the query entities
Parameters Defines the query parameters and is most used for effective dating
Filters Defines any filters applied at the topic level
Query Entities
Query Entities are like database tables. They are comprised of either Dayforce database tables or views.
They are the logical grouping of data in Dayforce which are used like tables. Query entities are grouped
together using relationships to form a topic. All topics will have at least one query entity, but most will
include many query entities.
You can view the query entities used in a topic in the Reporting Reference Guide. If you are in a report,
you can view the query entities used in that report by opening the Relationships editor in the Report
Designer. There you can view the query entities that are used in the report’s topic.
Activity: Add Site and Region to the Employee Health Election Report
Time: 5 minutes
Scenario: XYZ Company needs to run a report that shows employee health elections by site and region.
You review the available templates, and you see that there is an Employee Health Elections template.
After you preview the template, however, you see that it has everything that you need except the
employee’s site and region. Add the site and region into the report.
Solution: Add Site and Region to the Employee Health Election Report
Create the new dataset:
Path: Reporting > Reports
1. Double-click the Employee Health Elections template.
2. Click Save As.
3. Type “Employee Health Elections with Site” for the Report Name.
4. Click OK.
5. Remove Plan Sub Type column.
6. Select Add Field from the Fields list on the toolbar.
7. Click Organization from the Categories list.
8. Clear Benefits from the Categories list.
9. Type “site” in the Keyword search box.
10. Click Select All from the Relationship Levels list.
11. Click Apply.
12. Click Employee Work Assignment > Location > Location Hierarchy.
13. Click OK.
14. Add Site field to the report.
15. Add Region field to the report.
16. Click Grouping.
17. Group by Site and Region
18. Change the grouping order:
• Region
• Site
• Employee
19. Click Apply.
20. Click Preview.
21. Click Save.
If you anticipate that your organization’s structure will change over time, incorporate effective dating.
Effective dating will be discussed later in this course.
Relationships
Relationships, also called joins, identify the connection between query entities. Analyzing which query
entities are included and the types of joins they use will help you understand the resulting dataset.
Keys
Relationships combine query entities through keys identified in the database. The two types of keys are
primary keys and foreign keys.
Key Description
Primary Key • Uniquely identifies each record in a query entity
• Labeled with “Id” after the name of the query entity in Dayforce, for
example, Employee Id
Foreign Key • Field that contains a value that is shared from the related query entity’s
primary key
• Used to join the query entities
In the example below, the Employee query entity’s primary key is labeled Employee Id. That same value
is shared with the Employee Work Assignment entity in a foreign key labeled Employee Work
Assignment.Employee Id.
Query entity relationships use the primary key from one query entity related to the foreign key of the
related entity. Dataset Builder includes functionality to automatically establish the relationships.
16 Updating V2 Topics Expanding Reporting Power Using the Dataset Builder
However, it’s a best practice to review these relationships, to ensure they are the ones you want to
create.
Because there isn’t a direct relationship between the two query entities, you will need at least one
additional query entity to make the connection, even though you are not displaying fields from it. Below
is one way to associate the Employee query entity to the Department query entity.
So, the Employee Work Assignment and Position query entities are used to relate data between the
Employee and Department query entity.
In another example, you may want to add a Location Description to your report. However, the topic that
your report uses doesn’t have a query entity the contains the Location Description field. After a quick
review of the Reporting Reference Guide, you notice there are almost one hundred query entities with
fields containing the word “location.”
Fortunately, Dataset Builder assists your efforts in identifying which query entities relate to each other.
If you select Organization from the Categories list, search for the Keyword “site” and choose all the
relationship levels available, you will see all the possible relationship options.
Many times, there are multiple query entity relationship options presented. For example, how could
your dataset differ if you pulled Location from the Employee Pay Summary, Employee Work Assignment
or Pay Run Result query entities? Although each potential scenario may still return the employee’s
Location, your dataset could be significantly different, as illustrated below:
Joins
Joins allow you to create one row or record by matching records in two or more related query entities.
In Dayforce, the Inner Join and Left Join are available.
In the example below, you are reviewing the Employee and Time Away from Work tables. You have
been tasked to report the employee name with the start and end period for each employee’s time away
from work. You will need to combine the tables to report the necessary data using a join. In the
following sections, you will see how the dataset changes when you choose between an inner join and a
left join.
Inner Join
Inner joins return all the matched rows between related query entities. It matches records using primary
and foreign keys between the query entities. In other words, an inner join is a subset of matched
records between the query entities. Any unmatched records are not included in the dataset.
In the illustration below, the shaded area represents all the related records that will show up in the
dataset, where the primary key from Employee matches the foreign key of Time Away from Work
(TAFW). All other records are excluded from the dataset.
So, if join the tables using an inner join, the dataset will only include those rows where the primary key,
Employee.Emp_Id, matches the Time Away from Work foreign key, TAFW.Emp_Id.
In the tables below, notice that Colin Kennedy and Jill Hopkins do not show up in the new dataset. This is
because there is not a matching Time Away from Work record.
Left Join
Left Joins return all rows from the table on the left, even if there is not a matching record in the table on
the right. This allows you to ensure that you capture all records in the table on the left for the report.
In the illustration below, the shaded area represents all the related records that will show up in the
dataset. These records include all the Employee records and the Time Away from Work records where
the primary key from Employee matches the foreign key of TAFW.
20 Updating V2 Topics Expanding Reporting Power Using the Dataset Builder
So if you take our tables from our initial example above, and join them using an left join, the dataset will
include all rows in the Employee table and those records in Time Away from Work where the primary
key, Employee.Emp_Id matches the Time Away from Work foreign key,TAFW.Emp_Id. Notice that
records for Colin Kennedy and Jill Hopkins are now included in new dataset.
When you add a query entity using the Dataset Builder, the left join is defaulted.
Now, look at the same report using a left join. When the left join is used, you will see all the records on
the left-side query entity, even if there isn’t a corresponding record on the right-side query entities.
Record Conditions
While the relationships between query entities impact which records are returned in a report, they are
not the only component dictating the dataset. Datasets are further impacted by record Conditions.
Record conditions identify the requirements that must be met before records are returned in the
dataset. Record conditions narrow down or identify the data to be returned. They are specified in
Relationships, and most of the time will use the topic’s or report’s Parameter. We will discuss
Parameters in the next section.
In this example:
1. The first record condition is created from the inner join between the Employee and Employee
Work Assignment query entities.
2. The second record condition is created to narrow down the dates for which you want to see the
work assignments by using a Parameter in the Compare to Field.
Record Conditions in Relationships can yield profound differences in the dataset. Record conditions in
Relationships provide an opportunity to apply join type functionality to the condition (as well as the join
itself).
24 Updating V2 Topics Expanding Reporting Power Using the Dataset Builder
For example, in the Employee Details template, which uses the HR Profile – As of Date topic, record
conditions are specified in Relationships refer to the Employee Marital Status relationship. Because the
marital status can change over time, records in the Employee Marital Status entity are effective dated.
Editable parameters are set by the report user when the report is previewed, run, or scheduled. One of
the primary advantages to using is parameters is that the value only needs to be defined once but can
be used for many record conditions. Below are the conditions in the Relationships dialog box for a
report that uses the HR Profile – As of Date topic. The parameter is set at runtime. This parameter,
@AsOfDate, is used for many of the conditions in this topic.
When you run a report using the HR Profile – As of Date topic, you will be prompted to assign the
@AsOfDate, or As of Date. The date you define will be assigned to all the Conditions that use the
@AsOfDate variable. This will filter the records returned in your dataset.
You can delete topic-level and report-level parameters. If you remove parameters from a report that is
based on a topic, the report becomes detached from the topic.
26 Updating V2 Topics Expanding Reporting Power Using the Dataset Builder
Filters
A few topics enforce effective dating by using topic Filters. An example of using the Filters option is
present in the Payroll – Pay Run Summary topic. There are parameters that specify @EffectiveStart and
@EffectiveEnd, representing the Effective Start and End Dates for the reports. These two dates allow
you to specify a date range for the results.
Although the parameters are not specified on the Relationships tab in this topic, it does not mean there
is not criteria used to impact the dataset.
In this topic, the parameters are not referenced in Relationships, so how would they impact the dataset?
It is specified in the topic Filter. You can view this filter when you run or preview the report.
When you run the report, you are prompted to enter the date range. The dataset will be narrowed
down by the committed pay dates within the date range that you specify. The parameter allows you to
specify the date range. The pay date must fall between the two specified dates for the records to be
returned in the dataset. Any employees who do not have pay run records in the specified date range will
not appear in the dataset.
Effective Dating
Record conditions, along with relationships, are the critical elements that specify which records are
returned in the dataset. They are necessary because most of the query entities used in reports contain
either historic records, like Employment Status, or primary or secondary records, like primary and
secondary Work Assignments. Some contain both.
For example, look at Elaine Craig’s Employee Employment Status history in People:
Elaine has four records in her Employee Employment Status history. Consequently, without defining a
record condition, Elaine would appear at least four times in a report using a topic with the Employee
Employment Status entity included.
Unwanted multiple records are returned in a dataset when record conditions have not been specified
when you add a new query entity into a report. Adding multiple query entities without record conditions
will have a compounding effect in the dataset.
Based on viewing Elaine’s record in People, we know she has four Employee Employment Status records.
Let’s also imagine she has three records in her Employee Work Assignment history. If we were to
combine those query entities, we would need the Employee query entity to relate each of the entities.
All employees should have one record in the Employee entity.
28 Updating V2 Topics Expanding Reporting Power Using the Dataset Builder
What will the dataset be if you had a report based on a topic with only the three query entities included
and only the following relationships were specified?
1. Inner join between:
a. Employee to Employee Employment Status
b. Employee to Employee Work Assignment
2. No other record conditions set
Elaine would display in the dataset 12 times. Multiple records returned in a dataset will compound.
Every Employee record will be repeated with every Employee Employment Status record, and all those
records will be repeated by every Employee Work Assignment record (1 x 4 x 3 = 12 records returned).
By using effective dating, you can filter the results to include only the records that provide the
information that you need. For instance, you may want to specify results from a particular date, a
specific date range, or a date variable, like the last calendar month. Effective dating allows you to define
this with Parameters. Here are some common effective date types:
Option Description
As of Date (Point-in-Time) Allows results as of a specific date.
Date Range, Within, Allows results that are effective between certain dates
Between
End Date is Null Allows a result set for those who do not have end dates in their
records (not recommended)
Based on another entity’s Uses a date in another query entity to determine if the record
effective date will be returned
Optional Activities
Create a Report from a Blank Dataset
It is best practice to start reports using an existing topic from the Dayforce library. While you can create
a report with a new dataset in Dayforce, this should only be used as a last report for creating a report.
You can use this method to create a new report when the existing report topics do not meet your
organization's specific reporting needs. When you start a report with a blank dataset, you can add the
query entities and fields that you need as long as the data can be joined with the other query entities
that you add.
The first step in creating a new dataset is selecting the primary query entity, which forms the base for
building the dataset of the report. All query entities are assigned to categories according to the modules
that the data comes from. To select a primary entity, you can filter the list by selecting one or more
categories or by entering keywords. Other query entities that you want to use must be able to be joined
back to the primary query entity. You cannot change or remove a report’s primary query entity. If you
needed to change the primary query entity, you would have to delete that report and start again.
To create a report starting with a new dataset, complete the following steps:
1. In Reporting > Reports, click the Add button above the list of reports, and then select Add
Report. The Add Primary Query Entity dialog box opens.
2. Filter the list by selecting one or more categories or entering keywords related to the data that
you need in the report. The application can only display 100 query entities in this list.
3. Select a query entity to be the primary query entity.
4. Click OK to open the Report Designer.
5. Add more query entities from Add Fields to the Report Dataset as needed.
6. Add columns in the report.
7. Save the report.
32 Optional Activities Expanding Reporting Power Using the Dataset Builder
Going back to our former example, suppose you need to create a simple report with employee name,
work assignment and department name as of a specified date. While, you could probably find those in a
template, we will start one from scratch.
This opens the Add Primary Entity dialog box. In this dialog box, choose the primary query entity for
your new report. The primary query entity serves as the base for building your report. You can search
for fields for the Primary Entity by using keywords. You can't change the primary query entity after it has
been selected and added to the report.
The Primary Query Entity serves as the base for building your report. You can't change the primary
query entity after it has been set.
After you have chosen the primary query entity, the Report Designer opens so that you can continue
building your report by adding query entities, editing data relationships and adding report parameters as
needed. Use Add Fields as needed to bring in new related query entities.
In this example, the keyword “work assignment” is used to find the Employee Work Assignment query
entity.
34 Optional Activities Expanding Reporting Power Using the Dataset Builder
Create Parameters
When you create a report from a blank dataset, you can choose to use parameters to define a variable
that will be used in multiple conditions. Setting up a parameter allows you to create a variable can be
used in multiple places in the dataset. In Dayforce, most parameters are date parameters which are
used in the Compare to Field in Relationships.
To add a new parameter, click the Add button and define the new parameter.
In this example, a date parameter, names @AsofDate, is created. This new parameter can be used in any
condition or filter in the report.
In this example, the recording conditions are applied to enable effective dating to the Employee Work
Assignment query entity using the Parameter created in the new report.
29. Select the current date from the calendar picker in Value.
30. Click Editable.
31. Click Required.
32. Click Apply.
Review and update the relationships:
33. Click Relationships.
34. Click the line under Employee Work Assignment.
35. Click Add.
36. Click Employee Work Assignment.Employee Assignment Effective Start in the Fields list.
37. Click Less Than Equal in the Operator list.
38. Click @AsofDate in the Compare to Field list.
39. Click Add.
40. Click Employee Work Assignment.Employee Assignment Effective End in the Fields list.
41. Click Greater Than Equal in the Operator list.
42. Click @AsofDate in the Compare to Field list.
43. Click Apply.
Preview and save.
44. Click Preview.
45. Click Save.
The results will appear as follows:
For instance, you may want to report on the location of the employee’s primary work assignment and
actual location worked. The work assignment location and actual location worked both use the Location
query entity but use different relationships to access the location name. Dataset builder allows you to
add another query entity to the report with a different name, or alias.
If there are alias query entities available when you are using the Add Field function, the name of the
alias query entity will be followed by “Copy.” You will also be able to rename the alias query entity to a
new Display Name.
This example is from the Pay Summary template. The Location query entity is already used in this topic
from the Employee → Employee Pay Summary → Location relationships. However, to capture the
location from the employee’s primary work assignment, relationships must be built through the
Employee Work Assignment query entity, which will be Employee → Employee Work Assignment →
38 Optional Activities Expanding Reporting Power Using the Dataset Builder
Location. Since you can’t have two query entities name “Location,” you can rename the query entity. In
this example, the query entity is renamed “Work Assignment Location.” In Dayforce, you can only
rename a query entity that is aliased.
Rename report:
1. Double-click the Pay Summary template.
2. Click Save As.
3. Type “Pay Summary with Primary Location” for the Report Name.
4. Click OK.
Add field from outside the topic:
5. Click Add Field from the Fields list on the toolbar.
6. Select Human Resources, Organization and Time & Attendance from the Categories list.
7. Type “location name” in the Keyword search box.
8. Select Employee from the Related Entity Filter list.
9. Select Select All from the Relationship Levels list.
10. Click Apply.
11. Click Employee > Employee Work Assignment > Location (Alias).
12. Type “Primary Location” in Display Name.
13. Click OK.
14. Click Location in the report header.
15. Type “Location Worked” for Display Name.
16. Click Apply.
17. Insert Primary Location > Location Name to the right of Location Worked.
18. Click Location Name in the report header.
19. Type “Primary Location” for Display Name.