Example: Print a Custom Report in a Workday Studio Integration

This example illustrates how to extract the custom report data from Workday and generate a PDF file using Workday Studio.

Your HR department asks you to generate a new hire letter in PDF format. You'll use a custom report definition and Workday assembly project in Workday Studio to generate the PDF.

Create a report design for a new hire letter with the dynamic translation based on locale. See Example: Create a Report Design With Dynamic Translation Based on Preferred Locale.

Create a letter outlining employee benefit enrollments. See Example: Create a Report Design with Multiple Data Sets.

Access the

Create Custom Report

task.

Configure these values:

Option	Value
Report Name	Employee Benefit Enrollments
Report Type	Advanced
Enable As Web Service	Select this check box.
Optimized for Performance	Clear this check box.
Data Source	All Active and Terminated Workers

On the

Columns

tab on the

Edit Custom Report

page, configure these values:

Business Object	Field	Column Heading Override	Column Heading Override XML Alias
Worker	Legal Name - Last Name	Last Name	Last_Name
Worker	Legal Name - First Name	First Name	First_Name
Worker	Employee ID	Employee ID	Employee_ID
Worker	Supervisory Organization	Organization	Organization
Worker	First Day of This Calendar Year	Benefit Enrollment Date	Benefit_Enrollment_Date
Worker	Current Worker	Signatory	Signatory
Worker	Business Title	Signatory Business Title	Signatory_Business_Title
Worker	Work Address - Full	Work Address	Work_Address
Benefit Elections	Benefit Type	Benefit Type	Benefit_Type
Benefit Elections	Benefit Provider	Benefit Provider	Benefit_Provider
Benefit Elections	Coverage	Coverage	Coverage
Benefit Elections	Dependents	Dependents	Dependents
Benefit Elections	Current Election Coverage Begin Date	Effective Date	Effective_Date
Benefit Elections	Group Number	Group Number	Group_Number

Add a

Group Column Heading

for the secondary business object, Benefit Elections. Enter Benefit Elections
for both the

Business Object

and

Group Column Heading

fields.

Open Workday Studio.

Create a new

Workday Assembly Project

named CallPrintPdf
.

In the

Project Explorer

view, right-click CallPrintPDF/ws/WSAR-INF
and create a new My_Report_Designs
folder.

Add these components to your assembly project and link them together:

Component Type	ID
workday-in	StartHere
workday-out-rest	RequestCustomReportData
Async-mediation	SetReportandReportDesignVars
PdfPrintStep	GeneratePDF
Async-mediation	UploadToWorkday

Configure the Report Service on the

StartHere

workday-in component.

In the

Properties

view, access the

Services

tab for the

StartHere

workday-in component.

Select the

Create Report Service

icon and name it StartHere
.

Select the

Add New Entry

icon and enter these values:

Option	Value
Alias	mynewhireletter
Description	My New Hire Letter Report
Report Reference	My New Hire Letter Report

Configure the

RequestCustomReportData

workday-out-rest component.

On the

RequestCustomReportData

workday-out-rest component, select

Select a RaaS Report

on the

Extra Path

property.

On the

Filter Custom RaaS Reports

page, specify Employee Benefit Enrollments
for the custom report name, then click

Select the report, then click

Finish

Specify EmployeeBenefitEnrollments
for

Report Alias

, then click

Finish

On the

Extra Path

property on the workday-out-rest component, enter

@{intsys.reportService.getExtrapath('mynewhireletter')}?Worker!Employee_ID=21099!21189

Configure the

SetReportandReportDesignVars

async-mediation component.

Add 2 write steps on

Properties

tab of the

async-mediation

assembly component and configure these values:

Step 1	Step 2
StepID: WriteReportToVariable Input value: message Output value: variable Variable name: test.workday.report	StepID: CopyReportDesignToVariable Input value: message Output value: variable Variable name: test.report.design

Using the

Message Builder

, add a static-file element.

Specify

@{'my_report_designs/New_Hire_Letter.rptdesign'}

as the report design file location in the

Input File

property.

On the

Properties

view of the

GeneratePDF

PDF print step component, click the

Select Parameter

button on the

Parameters

tab.

Configure these parameters:

Parameter Name	Value
pdf.report.design.variable	test.report.design
pdf.workday.report.variable	test.workday.report
pdf.timezone	CET
pdf.language	fr_FR
pdf.locale	fr_FR
pdf.business.form.layout.wid	fbbe44a681251000039acc2ff657000a
pdf.report.design.wid	fbbe44a6812510000399fdf02c3f0006
pdf.apply.report.design.per.row	true

Store the generated PDF file with the UploadToWorkday
async-mediation component.

Add a

Store

step component with an Output MIME type of application/pdf
. Name the

Output

variable test.document.reference
.

Right-click the project in the

Project Explorer

and select

Deploy to Workday

In the

Cloud Explorer

, right-click the

StartHere

workday-in integration node , then select

Launch Integration

Access the PDF file on the W:Drive
.

Select the

Process Monitor

view, then click the

Workday: Process Monitor

icon.

W:Drive

On the

My Reports

tab, in the

File Name

column, click the

PDF

icon.

Concept: Common Components