1. Reference Guide for Certificates of Completion
SuccessFactors Learning
Report Designer
Reference Guide for Certificates of Completion
Reference Guide for Certificates of Completion
This icon on a slide means you should refer to Notes pages for more detail

2. Report Designer - Reference Guide for Certificates of Completion
Lesson 1
Activity A:
Customize Admin-Side
Certificate of Completion
This first activity provides instructions and a chance to practice customizing the Certificate of Completion report as run from the admin side. The activity uses the Certificate of Completion for scheduled offerings (CertificateOfCompletionScheduledOffering.rptdesign).
Task 1 begins by researching the existing report, then covers basic editing skills for changes such as:
Editing font
Modifying table layout
Adding a new field from the same data set
Task 2 adds a layer of complexity by:
Using conditional display of logos, based on a user attribute
Defining conditional visibility, based on input from the admin at run time
November 8, 2011

3. STEP 1: EVALUATE THE REPORT REQUEST
Report Designer - Reference Guide for Certificates of Completion
STEP 1: EVALUATE THE REPORT REQUEST
Your Mission: Research the requested certificate and evaluate desired output (next 2 slides)
November 8, 2011

4. For Task 1 – Original Certificate
Report Designer - Reference Guide for Certificates of Completion
For Task 1 – Original Certificate
November 8, 2011

5. For Task 1 – Requested Certificate
Report Designer - Reference Guide for Certificates of Completion
For Task 1 – Requested Certificate
Note the differences between the existing report and the requested certificate.
Formatting enhancements:
Different font size, type, and color
Addition of image and/or logo
Border around the outside
Changes to data:
Completion Date format removes the time stamp
Addition of organization ID with the user name
Addition of a pre-signed certificate with instructor “signature”, based on admin input
November 8, 2011

6. STEP 2: RESEARCH EXISTING REPORT
Report Designer - Reference Guide for Certificates of Completion
STEP 2: RESEARCH EXISTING REPORT
Your Mission: Research the existing report. Identify data, layout options, conditional settings, and scripts
November 8, 2011

7. To Research Existing Report
Report Designer - Reference Guide for Certificates of Completion
To Research Existing Report
Open the report in Report Designer (see Notes page)
Set up data source for your environment
Research data layout and identify related tables/fields (slides 9 and 10)
Research data sets and related scripts (slides
Steps to get ready:
Go to the LMS > Reports menu.
Export the Certificate of Completion for Scheduled Offerings.
Copy the report to your Report Designer workspace.
Unzip the export file – you may be prompted to overwrite existing files.
Open the report in Report Designer and save it with a unique name.
November 8, 2011

8. Research Data Layout and Fields
Report Designer - Reference Guide for Certificates of Completion
Research Data Layout and Fields
Reports > User Management > Certificate of Completion for Offerings Report
Research the Certificate of Completion report illustrated above. This report is often requested for customization.
Browse through SQL Developer and locate the relevant table(s).
Mark up the diagram to show the source of the data displayed in this report.
Refer to the next slide for answers if needed.
November 8, 2011

9. Findings for Data Layout and Fields
Report Designer - Reference Guide for Certificates of Completion
Findings for Data Layout and Fields
Reports > User Management > Certificate of Completion for Offerings Report
PA_CPNT_EVTHST.stud_id enables look up to
PA_STUDENT.fname and lname and MI
PA_CPNT.cpnt_title
PA_CPNT_EVTHST.compl_dte – OR – from admin input
You could stop here and you would have an accurate idea of the data used in this certificate.
But there is more to the story.
There are TWO data sets available to this one report element.
PA_CPNT_EVTHST.inst_name or if sched offering - PA_SSG_INST and PA_INST
Label from admin input
November 8, 2011

10. Research Data Set: cert_complschd
Report Designer - Reference Guide for Certificates of Completion
Research Data Set: cert_complschd
For events after learning is recorded
SELECT s.lname, s.fname, s.mi, schd_desc as cpnt_title, h.compl_dte,
sr.inst_id, i.lname as inst_lname, i.fname as inst_fname, i.mi as inst_mi
FROM pa_sched a, pa_student s, pa_cpnt_evthst h,
ps_schd_resources sr , pa_inst i, pa_cmpl_stat cs
WHERE h.stud_id = s.stud_id
and a.schd_id = h.schd_id
and h.cmpl_stat_id = cs.cmpl_stat_id
and cs.provide_crdt = 'Y'
and sr.inst_id = i.inst_id(+)
and h.schd_id = sr.schd_id(+)
/** and h.schd_id in [ScheduleSearch] and [security:pa_student s] */
Research the query for cert_complschd and make notes about key points.
This query retrieves:
User ID, item title, and completion date from the learning history table
Instructor ID from PS_SCHD_RESOURCES, based on the schedule ID
Only records for which completion status has provide credit = yes
November 8, 2011

11. Research Data Set: cert_enrlschd
Report Designer - Reference Guide for Certificates of Completion
Research Data Set: cert_enrlschd
For enrolled students, before event is recorded
select s.lname, s.fname, s.mi, schd_desc as cpnt_title, a.schd_id, sr.inst_id, i.lname as inst_lname, i.fname as inst_fname, i.mi as inst_mi, '' as compl_dte
from pa_enroll_seat a, pa_sched b, pa_student s, pa_enroll_stat d,
ps_schd_resources sr, pa_inst i
where a.stud_id = s.stud_id
and a.schd_id = b.schd_id
and a.enrl_stat_id = d.enrl_stat_id
and d.enrl_stat_typ_id = 'E'
and a.schd_id = sr.schd_id(+)
and sr.inst_id = i.inst_id(+)
/** and b.schd_id in [ScheduleSearch]
and [security:pa_student s] */
Research the query for cert_enrlschd and make notes about key points.
This query retrieves:
User ID from the PA_ENRL_SEAT table for students where enrollment status = Enrolled
Item title from PA_SCHED
Instructor ID from PS_SCHD_RESOURCES, based on the schedule ID
Only records for which completion status has provide credit = yes
The query does not retrieve completion date. It simply creates a blank as a placeholder. The “Completion Date” field in the report displays the value entered by the admin in the CompletionDate report parameter.
November 8, 2011

12. Selection of Data Set is Conditional
Report Designer - Reference Guide for Certificates of Completion
Selection of Data Set is Conditional
If admin checks report parameter, “Run for completed events only” – use cert-complschd and get completion date from learning history
If admin unchecks report parameter, “Run for completed events only” – use cert-enrlschd and get completion date from admin input
NOTE: If permitted by the company’s business rules, this configuration allows an admin to print completion certificates before recording learning history.
November 8, 2011

13. Research Script that Uses Input
Report Designer - Reference Guide for Certificates of Completion
Research Script that Uses Input
Locate properties for the report in Layout view (or look at XML Source tab)
Select Script tab
View Script field option for Before Factory
November 8, 2011

14. Report Designer - Reference Guide for Certificates of Completion
Script Process Flow
Report Parameter: 1
notEqual true = unchecked
if (BirtComp.notEqual(params ["CompletedOnly"], true )) {
certificateTable = reportContext.getReportRunnable().
designHandle.getDesignHandle(). findElement("Certificate");
certificateTable.setProperty( "dataSet", "cert-enrlschd" ); 2 3
November 8, 2011

15. How Populate “Completion Date”?
Report Designer - Reference Guide for Certificates of Completion
How Populate “Completion Date”?
November 8, 2011

16. STEP 3: MAKE FORMAT CHANGES
Report Designer - Reference Guide for Certificates of Completion
STEP 3: MAKE FORMAT CHANGES
Your Mission:
Edit font and report layout. Add a background image to your certificate.
As of version 6.3, background images do not work as they did in earlier versions. This presentation will be updated soon to reflect these changes
November 8, 2011

17. Create a Border and Add Image
Report Designer - Reference Guide for Certificates of Completion
Create a Border and Add Image
Add to master page as header
Add to grid on layout panel
November 8, 2011

18. STEP 4: MAKE DATA CHANGES
Report Designer - Reference Guide for Certificates of Completion
STEP 4: MAKE DATA CHANGES
Your Mission:
Edit query and add data field. Use new field in layout. Hide signature where applicable.
November 8, 2011

19. Add New Field to the Query
Report Designer - Reference Guide for Certificates of Completion
Add New Field to the Query
Desired output includes organization ID
Add PA_STUDENT.org_id to query
Remember to refresh binding for the table
SELECT s.lname, s.fname, s.mi, c.cpnt_title, s.org_id
FROM pa_student s, pa_cpnt c
November 8, 2011

20. Include New Field in the Certificate
Report Designer - Reference Guide for Certificates of Completion
Include New Field in the Certificate
Modify user name field to include organization ID
November 8, 2011

21. Define Visibility for Signature
Report Designer - Reference Guide for Certificates of Completion
Define Visibility for Signature
Signature line only relevant for leader led or blended
Can set visibility of this element to hide if classification is online or other (see notes) 1 2
This solution requires that you edit the query in the master data set to retrieve PA_CPNT.cpnt_classification field (shown in italics):
select s.lname, s.fname, s.mi, c.cpnt_title, c.cpnt_classification
from pa_student s, pa_cpnt c
Remember to refresh the table binding to pick up this column.
Steps to Define Conditional visibility
Locate the element. In this example shown, the designer inserted a row in the existing table. Then the designer moved the signature field to the row.
While highlighting the element, go to the Property Editor view (in screen shot above, the view is below the Layout pane).
Select the Visibility option from the left menu.
Select the box for Hide Element.
Go to the Expression field and select Expression Builder icon.
Build this expression so that Report Designer hides the signature block if the item type is online or “other” (physical good):
row ["CPNT_CLASSIFICATION"] == 'CONTINUOUS ONLINE ACCESS' || row ["CPNT_CLASSIFICATION"] =='PHYSICAL GOOD' 4 3 5
November 8, 2011

22. Test the Report in the LMS
Report Designer - Reference Guide for Certificates of Completion
Test the Report in the LMS
Wrap up editing for Task 1
Ensure that data set queries are correct
Remove extra WHERE clauses used for testing
Export the Certificate of Completion
Import the report into the LMS
Execute your test plan with a variety of scenarios, such as titles with two lines
November 8, 2011

23. Task 2: Add Conditional Fields
Report Designer - Reference Guide for Certificates of Completion
Task 2: Add Conditional Fields
Set up conditional display for logos:
Add logos as embedded images
Define script to select logo, based on user attribute (organization ID)
Display/hide signature block, based on admin input:
Set up report parameter for admin input
Place image on certificate
Define image visibility based on input
November 8, 2011

24. Report Designer - Reference Guide for Certificates of Completion
Plan the Certificate
The desired certificate selects a logo based on an attribute of the user record. In the example shown here, the organization ID field from PA_STUDENT determines which logo to display:
If organization ID= NA-STEEL, display NA Steel logo
If organization ID = EU-STEEL, display EU Steel logo
November 8, 2011

25. Report Designer - Reference Guide for Certificates of Completion
Report Layout - After
Signature image
Name from admin input
Title from admin input
November 8, 2011

26. Define Visibility for Image
Report Designer - Reference Guide for Certificates of Completion
Define Visibility for Image
For certificate via LER or if user generated, hide grid when item classification is Online or Other
Expression says that if admin did not enter signing officer name = “Melissa Riesco”, hide signature image for Melissa Riesco
Here is another example of setting up a field that is displayed only when the admin selects the matching report parameter.
In this example, the report defines visibility for the signature block:
Display the image with Melissa Riesco’s signature if the admin enters “Melissa Riesco” in the report parameter for Name of Signing Officer
Hide the signature image if the admin enters a different value in the Name of Signing Officer field
In both cases:
Print the name from the Name of Signing Officer parameter under the signature line
Print the value of the Designation report parameter under the name
November 8, 2011

27. Define Conditional Logo
Report Designer - Reference Guide for Certificates of Completion
Define Conditional Logo
By default, report displays KSO logo
If organization ID is NA-STEEL (per user record org ID), then show the NA-STEEL logo
If org ID is NA-OIL, show NA-OIL logo
For conditional logos, you can use scripts. In this case, Plateau used the syntax for “this.file”. That structure requires that the image be available as a shared resource, not embedded in the report.
To make this syntax work when running the report from inside the Plateau application, you must copy the logo images to the application server.
Place the images under the root directory (not the images directory) where the Eclipse/BIRT engine runs. The directory is specified in the ELMS.xml file. In a local instance, the default is C:\TEMP.
November 8, 2011

28. Conditional Logo (continued)
Report Designer - Reference Guide for Certificates of Completion
Conditional Logo (continued)
Be sure to set up the image as Image file in shared resources to make this work
In the java script, use the title of the image exactly, matching the Enter resource file field
November 8, 2011

29. Conditional Logo – Field from Record
Report Designer - Reference Guide for Certificates of Completion
Conditional Logo – Field from Record
May not be the most elegant or efficient, but this does work: {
if (row["ORG_ID"] == "NA-STEEL")
this.file = this.file.replace ("logo_KSO.png",
"logo_NA-STEEL.png"); }
if (row["ORG_ID"] == "EU-OIL")
"logo_EU-OIL.png");
if (row["ORG_ID"] == "NA-STEEL-SALES")
this.file = this.file.replace("logo_KSO.png",
"logo_NA-STEEL-SALES.png");
November 8, 2011

30. Conditional Logo – Multiple Plan B
Report Designer - Reference Guide for Certificates of Completion
Conditional Logo – Multiple Plan B
Another way to accomplish this is to pull the image from a table in the database.
To select from a set of logos, you would need to create a table with images
November 8, 2011

31. Conditional Logo – Multiple Plan C
Report Designer - Reference Guide for Certificates of Completion
Conditional Logo – Multiple Plan C
Another way to accomplish this is to insert all logos
Then hide the logo if the value from report parameter does not match
Works best if you have only 2 or 3 logos
November 8, 2011

32. Conditional Logo – Parameter Input
Report Designer - Reference Guide for Certificates of Completion
Conditional Logo – Parameter Input
Can set up a report parameter to prompt admin to select from drop down list
Use the parameter value to define logo display {
if (params["Center Delivering the Training"].value =="Kennedy Space Center")
this.file = this.file.replace("logo_HQ.png",
"logo_KSC.png"); }
November 8, 2011

33. Report Designer - Reference Guide for Certificates of Completion
Preview and Finalize
Wrap up editing for Activity A
Finish editing in Report Designer
Use checklist to prepare report for Plateau
Export the Certificate of Completion with conditional configuration
Test the report in Plateau
When satisfied – try out Activity B
Customize certificate that users print
Remember that you must test this report on the user side
November 8, 2011

34. Report Designer - Reference Guide for Certificates of Completion
Lesson 1
Activity B:
Customize User-Side
Certificate of Completion
November 8, 2011

35. How the User-Side Certificate Works
Report Designer - Reference Guide for Certificates of Completion
How the User-Side Certificate Works
select s.lname, s.fname, s.mi, c.cpnt_title
from pa_student s, pa_cpnt c
where 1 = 1
/** and s.stud_id IN [UserSearch]
and (c.cpnt_typ_id, c.cpnt_id,c.rev_dte)
in [ItemSearch]
and [security:pa_student s] */
order by lname, fname, mi, c.cpnt_typ_id,
c.cpnt_id, c.rev_dte
The user-side certificate does not run a report using the kind of query that is used for the admin-side report.
Notice that this query does not make sense! It is not pulling from learning history. The “query” just retrieves the user name and the item title, based on user login and which item the user selected for this certificate.
The java code on the page then places the related fields onto the certificate.
November 8, 2011

36. Analyze the User-Side Certificate
Report Designer - Reference Guide for Certificates of Completion
Analyze the User-Side Certificate
Note: You cannot change the output to print date only without the time stamp. To do this requires a change to the query used to generate the report.
November 8, 2011

37. Testing in Report Designer
Report Designer - Reference Guide for Certificates of Completion
Testing in Report Designer
Yikes!
If you run this report in Report Designer without editing the query, you will generate a certificate
for every user in the database
for every item in the database
The query has no criteria. That is because the application executes code at run-time to select the one item in learning history that maps to the “Print Completion Certificate” button.
Testing Tips Gleaned from Hard Experience:
Be sure to edit the query before testing
Certificates of Completion will be large files and you must view them in PDF format to determine precise layout
Fine tune the query to generate no more than 10 results for faster edit  preview  edit cycle
Use the Preview Results button while you are still in the data set in edit mode to ensure that your data subset is small
Remember to fix the query before the report exporting to Plateau
November 8, 2011

38. Remove Extra Page Break
Report Designer - Reference Guide for Certificates of Completion
Remove Extra Page Break
Core report from Plateau prints extra page
The report file used for training includes just one page break = always
The report provided by SuccessFactors may include an extra page break. The page break property is set to Always for the table, for the row with Signature Text, and for the footer row.
You can search in the XML Source tab to find the settings where Page Break is set to Always. Then change all but ONE of the entries to Auto.
If this does not work – you can try setting the top and bottom margins for the master page to .25 inches.
See Notes page to find page break in XML source
November 8, 2011

39. Rolling Out Certificate – User Side
Report Designer - Reference Guide for Certificates of Completion
Rolling Out Certificate – User Side
Make final changes and zip the file.
Import into the LMS with the EXACT name: CertificateOfCompletionLearningHistoryUser
Add a note in the Description field such as your name and date/time imported.
Save the file and close the window.
Now you have TWO versions of the report – one published (the system report) and one unpublished (your new version)
Immediately edit your unpublished version and change it to published
Go the user side and test from Completed Work pod/Learning History
November 8, 2011

40. Report Designer - Reference Guide for Certificates of Completion
Preview and Finalize
Wrap up editing for Activity B:
Finish editing in Report Designer
Export the Certificate of Completion
Log in to the user side and test in the LMS
November 8, 2011

41. True Query for User Side Certificate
Report Designer - Reference Guide for Certificates of Completion
True Query for User Side Certificate
select s.lname, s.fname, s.mi, c.cpnt_title, c.cpnt_classification, s.org_id, ev.cpe_hrs, ev.compl_dte
from pa_student s, pa_cpnt c, pa_cpnt_evthst ev
where s.stud_id = ev.stud_id
and c.cpnt_typ_id = ev.cpnt_typ_id
and c.cpnt_id = ev.cpnt_id
and c.rev_dte = ev.rev_dte
/** and s.stud_id in [UserSearch] and (c.cpnt_typ_id,c.cpnt_id,c.rev_dte) in [ItemSearch] */
order by lname, fname, mi, c.cpnt_typ_id, c.cpnt_id, c.rev_dte
Here is a sample query edited to work with the user-side Certificate of Completion **
** NOTE – Running a true query will slow performance, perhaps dramatically. Test carefully to be sure this is acceptable:
select s.lname, s.fname, s.mi, c.cpnt_title, c.cpnt_classification, s.org_id, ev.cpe_hrs, ev.compl_dte
from pa_student s, pa_cpnt c, pa_cpnt_evthst ev
where s.stud_id = ev.stud_id
and c.cpnt_typ_id = ev.cpnt_typ_id
and c.cpnt_id = ev.cpnt_id
and c.rev_dte = ev.rev_dte
/** and s.stud_id IN [UserSearch] and (c.cpnt_typ_id,c.cpnt_id,c.rev_dte) IN [ItemSearch] */
order by lname, fname, mi, c.cpnt_typ_id, c.cpnt_id, c.rev_dte
NOTE: Org ID would always show the current organization, not the organization at the time the user completed the course.
TIP: Leave all existing fields in the report, since they are being used. Just set the field(s) to be invisible.
November 8, 2011