1.0.0 Workday Reports: Report Writer
1.0.0 Workday Reports: Report Writer
Reports are basically defined using XpressO (Workday’s development tool). There is a
tool called Report Writer which helps to create reports that user can run directly from
home page. Report writer is a report writing tool designed by workday and access to
Report Writer is by the assignment of an Administrator Role.
Each report and Data Source is secured by Securable Items in Workday in a domain
security policy. Based on the security groups assigned to the users, the data sources
and the fields are visible. For ex: Manager who can access their staff personal details
may not be able to view their social security numbers.
The security also works for reports which are shared. Sharing does not override report
security and whenever user creates a report, he/she can only view those fields for which
they are authorized.
The Data Sources Report shows which security group has access to which data source
Data Sources:
A Data Source is Similar to a View in Relational Database
Each report will have only one Data Source
A Data Source provides access to a single type of Business Object
Refer to the Primary Business Object
One Row for each Primary Business Object Instance
Control security when a report is shared
Primary Business Object drives availability of other Objects via relationships
Business Objects:
Workday stores data as “Business Objects” which can be assumed as a table in
database. Each Object contains both Logic and Data.
Workday Business Objects has Fields (Columns) and Instances (Rows)
A Business Object can have One Instance or Multiple Instances
Primary Object:
Primary Object is a parent table. For ex: Worker is a Primary Business Object
Matrix Report:
A matrix report forms the foundation for custom analytics. It summarizes the data
by one or two fields that contain repeated values. The resulting matrix is
displayed as either a table or chart that users can drill down to see the
associated details. You can control the specific detail data users should see
when they drill down by selecting the desired fields when defining the report.
Matrix reports also provide features such as filtering, run time prompts, Worklets
and report sharing.
Scenario: Creation of “Employee Report” which list all the workers personal details and
hires details
Step 1: Login as lmcneil and Search for “Create Custom Report” and select the task as
shown below
Note: lmcneil is a “Super User” and “All Workers” Data Source lists all the workers
information
Note: “Test” option will retrieve the “Random” 10 results and Run will retrieve the data
based on the criteria if any.
Custom Report
After creating a new custom report and clicking on “Ok”, the system
prompts for Run and Test. On click of Run, the system results the data
Using “Run Custom Report” task in the report writer menu
By selecting custom report related action and click on Run option
Schedule a report
2.0.2 Schedule Reports
Schedule a report so that you don't need to manually run each time. For example, by
setting up a recurring process, you can automatically run a weekly report each Friday at 6
PM. When you schedule a report, it runs in the background, which allows you to continue
your work while the report is running.
Selecting a Custom Report -> Schedule from the report which is created
Steps:
If user want to schedule an Employee Report which is created, the user need to follow
the below mentioned steps
User can view the status by selecting Process Monitor task and the request name
While Creating Reports the report user should be aware of the following things
Where is the data that is needed?
• Step 1 – Choose the Data Source
What fields should be on the report?
• Step 2 – Select Business Objects, Related Objects and Fields
How should the report output be sorted?
• Step 3 – Define the Column Order
• Step 4 – Specify the Desired Sorting
Which rows or instances should appear on the report?
• Step 5 – Define the Filter Criteria & Prompting
Scenario: Create a report which lists all the terminated employees list
Order: enables you to define the order that fields should appear on the report. You can
move the order of the fields from up and down
Field: Represents the field name associated with the business object that should be
included in this column of the report. The prompt allows you to see the available fields for
the business object “By Category”, in which they are listed by functional grouping, or “All”,
which lists all the fields alphabetically. An icon is displayed next to each field which
indicates the field type. See Field Type Appendix for a description of what the icons
represent. To help you decide the appropriate field to use, click on the magnifying glass
next to the field name to see a description of the field. Note that only fields that are
authorized for the roles you hold will be displayed in the prompt list. Fields in the “Do Not
Use” prompt should not be used in a report.
Column Override: enable user to override the column heading label and this will be
used during integrations.
Options:
The Columns tab on the report definition allows you to specify the fields you want to
include on the report and the sequence in which they should be displayed on the report.
The columns grid contains one row for each field that should appear as a column on the
report. Each row in the grid defines the field, column heading overrides and options on
how the field should be displayed.
Business Object: the Business Object is defaulted to the primary business object of the
data source selected.
Field: The prompt shows the available fields for the business object “By Category”, in
which they are listed by functional grouping, or “All”, which lists all the fields
alphabetically. The icon displayed next to each field indicates the field type. See Field
Type Appendix for a description of what the icons represent.
Allows you to override the field name as the column heading on the report. If you don't
want to use the Field name as the column heading, enter the appropriate value in this
field.
The Filter tab on the report definition allows you to specify how you want to filter the
primary business objects for the report. This step is optional. If no filter criteria are
specified for a report, all instances from the data source will be included in the report.
Otherwise, only instances that satisfy the filter criteria will appear on the report. A filter
consists of one or more filter conditions, defined as rows in the filter grid.
EXAMPLE: Prompting for a range of values. In this example, assume you want to prompt the
user for a range of hire dates when they run the report. You would select "Starting Prompt" as
the Comparison Value for the first filter condition referencing the Hire Date field and "Ending
Prompt" as the Comparison Value for the second filter condition referencing Hire Date.
Here is how the filter conditions should look:
And/Or Field Operator Comparison Type Comparison Value
Hire Date is greater than Prompt the user for the value Starting Prompt
And Hire Date is less than Prompt the user for the value Ending Prompt
Advanced reports use sub filters for filtering the data of the related business
objects which are child tables. For ex: If user wants to filter data on employees
dependents then use sub filters
2.1.2.5 Define Prompting Overrides
Report prompts allow the user to specify different criteria for the same report
each time the report is run. Some data sources have built-in prompts. (See the
data source description for details.) You can also create your own prompts on an
advanced report by choosing Prompt user for the value as the Comparison Type
in a filter condition. Creating one report with prompts to provide filter criteria is
quicker and easier than creating multiple reports, each with "hard coded" filter
conditions.
On the Prompts tab you can specify optional prompt related data about your
report, such as prompt instructions, the sequence the prompt fields will be
displayed in, overrides for the prompt labels, etc. In the prompt grid you specify
the prompted field and enter override values. You can specify prompt overrides
for both built-in and user-defined prompts.
When an effective date or an effective date and time is specified at run-time, the
report returns only data values that were in effect at that date or time. If you don't
select a value for this field, the report returns data in effect as of the date and
time the report is run.
When an entry date or entry date and time is specified at run-time, the report
returns only data values that were in entered into the system at that date or date
and time. If you don't enter a value for this field, the report returns data entered
as of the date and time the report is run.
2.1.2.6 Define Output Options
By default, a custom report is rendered as a table and not enabled for use as a worklet.
Use the Output tab to override these defaults and define the reports:
Output type.
Chart options.
Worklet options.
2.1.2.7 Define Sharing Options
By default, a custom report is visible only to its owner. You can choose to share your
report with other Workday users or groups. Then, anyone meeting your sharing criteria
can run the report and view its definition (if they also have the Report Writer role).
Sharing a report with another user allows him or her to run the shared report, not edit the
report. In order for the shared user to be able to edit the report, the shared user must
copy the shared report and edit the copy of the report, or the report owner must transfer
ownership of the report to the shared user.
Enable As Web Service: Select this check box to expose this report as a web
service. If you select this option, then you must also define Column Heading
Override and Group Column Heading values on the Columns tab, and provide
Label Overrides for all prompts on the Prompts tab. You can also select which
Web Service API Version to use. The API version defaults to the API associated
with the current release of Workday. When an advanced report is exposed as a
web service, all supported web service options become accessible by selecting
Web Services > View URLs from the related actions menu for the report.
The above report retrieves the data as per the scenario and the results are :
After defining a custom report, you should test it to ensure it returns the data you expect
and formats it properly. If not, keep iterating between editing and testing until you are
satisfied.
To test a custom report, use the Custom Report > Test related action on the custom
report. This runs the report but only includes the first ten rows of data from the data
source. For reports with large data volumes, this significantly reduces the time required to
display the test results.
Don't share With this option selected, your report can be viewed and executed only by
report (default) you.
Share with all Select this option to share your report with any user who is authorized to
authorized access the report's data source.
users
Share with
Enables you to specify both authorized groups and individual authorized users
specific with whom you want to share the report. The report will be shared with a user
if he or she is a member of any of the authorized groups specified or is one of
authorized
the authorized users specified. When you select this option, the following
groups and fields become available:
users ← Authorized Groups: From among the security groups that are
authorized to access the report's data source, you can select a
subset. Only users with those security groups can access your
report.
← Authorized Users: Specify one or more users that can view and
run your report. Users must be in at least one security group that
allows them to access the data source.
Access the simple custom report that you want to change and select Custom Report >
Change to Advanced Report Type from the related actions menu.
It is not possible to convert an advanced report to a simple report. Nor is it possible to
convert simple or advanced reports to matrix reports or vice versa.
Select the Delete Custom Report task from the Report Writer category on the Navigate
slider, or open the custom report you want to delete and select Custom Report
Definition > Delete from the related actions menu.
You can only delete custom report definitions that you have created; you cannot delete
custom report definitions that others have shared with you.
2.4.0 Worklets
2.4.1 Define Worklet
A Worklet is a report that can be displayed in a "tile" on the Workday "landing pages",
which are: My Workday, All About Me, and My Team, and the Dashboard slide-out.
Worklets provide users quick access to frequently referenced data and tasks common to
a specific functional area. There are two types of worklets—Workday-delivered worklets
and custom worklets. For information on configuring the landing pages to display these
worklets
Workday Delivered worklets are Inbox, My Account and Personal Information. These
worklets cab be accessed by set of pre-defined groups
Custom worklets can be created by using Report Writer and specifying either the
advanced or the matrix report type, and then selecting Enable as Worklet on the Output
tab.
Customer worklets can be shared with other users. Just like advanced reports, worklets
have four sharing options, which are: “Don't share report”, “All authorized users,”
“Specific authorized groups”or“Specific authorized users”.
Worklet Creator/Owner
Here are the steps required to deploy a custom Worklet for shared use:
Worklet Creator/Owner
1. Follow steps 1 through 3 above.
Setup Administrator
← If the Worklet is to be required or recommended
for one or more security groups, update the
Worklet Page Layout Setup using the Edit Tenant
Setup task.
End User
← If the Worklet is recommended or optional, go to
the appropriate landing page and configure the
page to include the Worklet.
Workday enables you to expose advanced custom reports as web services. Web
services allow inter-operable, machine-to-machine interaction over the Internet. In
Workday, web services present report results as URLs, enabling integration between
Workday and external business services, such as payroll or benefits providers. Web
services also can be used to expose business data to external reporting tools, such as
Microsoft Excel. Output options for web services include:
← Workday XML
← Simple XML
← CSV
← RSS
← GData
← JSON
More details on each of these options are provided below. Note that there is also a
deprecated Internal REST/Workday Internal XML option that is not supported.
Step 1: Click “Enable as a Web Service” Checkbox: once the checkbox is located on the
Advanced Tab in the report. Once it is turned on and the report is saved the web service
URLs and XML can be accessed using the related action icon in the report.
Step 2:
Define column heading overrides: workday requires that column heading overrides be
defined for a web service enabled report. These headings will then be used in the XML
Schema
Step 3:
Define Group Column Headers & Prompt Label Overrides: workday requires that group
column headers be defined for a web service enabled report only if you define secondary
objects within your report. These headings, which are tied to secondary objects, will then
be used in the XML Schema. Prompt label overrides are required If a prompt is defined
within the report definition or If the Data Source has a Built in prompt(s)