Skip to main content
Documentation
Documentation
Administrator Guide
Last Updated: 2024-11-15
Example: Create a Report Design With a Chart

Example: Create a Report Design With a Chart

This example illustrates how to create a report design that includes a chart.
Your HR department wants you to create a report design for a summary of the employee total compensation package that includes a pie chart with the breakdown by the reward type. You need to create a Workday custom report with a primary business object for workers and a secondary business object for total compensation items.
  1. Sign in to your Workday GMS tenant.
    If you don't have a Workday GMS tenant, you can use any QA tenant in your Sandbox with the correct security access.
  2. Create a copy of the
    Employee Total Rewards
     custom report:
    1. Access the
      Employee Total Rewards
       custom report and specify 1 or more workers.
    2. From the related actions menu of the report, select the
      Custom Report
      Copy
       option.
    3. Name the new report
      My Employee Total Rewards
      .
    4. Click
      OK
      .
  3. Remove the unnecessary items from the report:
    1. On the
      Columns
       tab of the report, delete these rows:
      Business Object
      Field
      Column Heading Override
      Worker
      Total Number of Shares Granted
      Shares Granted Total
      Worker
      Calculated Grant Value - RSU
      Calculated Grant Value RSU
      Worker
      Calculated Grant Value - ISO
      Calculated Grant Value ISO
      Worker
      Calculated Grant Value - NSO
      Calculated Grant Value NSO
      Worker
      RSU Shares Granted
      RSU Shares Granted
      Worker
      ISO Shares Granted
      ISO Shares Granted
      Worker
      NSO Shares Granted
      NSO Shares Granted
      Worker
      Percent of Stock Options Vested
      Percent of Stock Options Vested
      Worker
      Color 1
       to
      Color 7
      .
      Color 1
       to
      Color 7
      .
      Worker
      Label 1
       to
      Label 7
      .
      Label 1
       to
      Label 7
      .
      Worker
      Company Logo URL
      Company Logo URL
      Stock Grants
      All rows.
      All rows.
    2. In the
      Group Column Headings
       grid, remove the
      Stock Grants
       business object row.
    3. In the
      Subfilter
       tab, remove the
      Total Rewards Items (Do Not Use)
       business object.
    4. Click
      OK
      .
  4. Open Report Designer in Workday Studio.
  5. Create a report project named
    My Employee Total Rewards
    . In that project, create a report file named
    My Employee Total Rewards.rptdesign
    .
  6. Create a Workday data source and download some sample data:
    1. Create a new
      Workday Report Data Source
       named
      My Employee Total Rewards
      .
    2. Download the report description for the
      My Employee Total Rewards
       custom report from Workday.
    3. Download sample report data from Workday and name the file
      My Employee Total Rewards.xml
      .
  7. Create the data set relating to the primary business object, Workers, with these values:
    Option Description
    Data Source Selection
    My Employee Total Rewards
    Data Set Type
    Workday Primary Report Data Set
    Data Set Name
    Workers
    Report Designer displays XML schema element values and names for the columns that you added as rows to your custom report for the Worker business object in Workday. Note that Report Designer adds a
    Row_Number
     column automatically to support grouping.
  8. Create the data set relating to the secondary business object, Total Compensation Items, with these values:
    Option Description
    Data Source Selection
    My Employee Total Rewards
    Data Set Type
    Workday Secondary Report Data Set
    Data Set Name
    Totals
    Business Object
    Total Compensation Items
    Report Designer displays the XML schema element values for each of the columns that you added as rows to your custom report for the Total Compensation Items business object in Workday, and their display names. It also displays a warning message about an empty
    PrimaryRowNumber
     input parameter value. You'll configure this later, so dismiss the message.
  9. Add a table to the layout:
    1. In the
      Outline
       view, right-click the
      Body
       node and select
      Insert Element
      .
    2. Double-click the
      Table
       element and configure these values:
    Option Description
    Number of columns
    1
    Number of details
    1
    Data Set
    Workers
    You only need 1 column and 1 detail row of your table. To delete the header and footer rows, as well as additional columns, right-click in the guide cell, then select
    Delete
    .
  10. Add
    Grid 1
     to the table:
    1. In the
      Outline
       view, right-click the
      Cell
       node located under
      Detail
      Row
      , then select
      Insert Element
      .
    2. Double-click
      Grid
       and configure 2 columns and 1 row.
    3. Right-click the first
      Cell
       node under
      Grid
      Row
      , then select
      Insert Element
      .
    4. Double-click the
      Image
       report item and select
      Embedded image
      , then click
      Add Image...
       to browse to the company logo image file.
    5. Right-click the second
      Cell
       node under
      Grid
      Row
      , then select
      Insert Element
      .
    6. Double-click
      Dynamic Text
       and select
      Available Column Bindings
      Table
      , then insert the column binding for
      Year
      .
      If you can't find the required column binding, click
      Edit Bindings...
       and refresh the list.
    7. Enter
      " Executive Rewards"
       after the
      +
       sign and click
      OK
      .
    8. Drag the
      Worker
       data set from the
      Data Sets
      Workers
       node to the second column, below the dynamic text report item.
    9. In the
      Property Editor - Data
       view, align the inserted items to the right.
    10. In the
      Property Editor - Grid
       view, name this grid
      Grid 1
       and collapse the grid.
    11. Save your work.
  11. Add
    Grid 2
     to the table:
    1. As before, insert a grid, then configure 1 column and 1 row.
    2. In the
      Property Editor - Grid
       view, select the
      Totals
       secondary data set from the
      Data Set
       list.
    3. From the
      Data Set Parameter Binding...
      Edit
       option, click
      JavaScript Syntax
      .
    4. In the
      Expression Builder
      , select
      Available Column Bindings
      Table
       and double-click
      RowNum
       to enter the
      row.__rownum
       expression.
    5. Add a chart to the grid.
      Report Designer doesn't currently support live preview for charts. You'll need to disable live preview before adding the chart. To do that, clear the
      Enable Live Preview in the chart builder
       check box in
      Report Design
      Chart
       in the
      Preferences
       menu.
      Right-click the
      Grid
      Row
      Cell
       node, then select
      Insert Element
      .
    6. Double-click
      Chart
       and configure these values:
      Field
      Value
      Select Chart Type
      Pie
      Output Format
      Select 1 of these options:
      • PNG
      • JPG
      • BMP
      If you select the
      SVG
       format option, the chart won't render when you generate a PDF.
    7. Click
      Next
      .
    8. On the
      Select Data
       tab, select and drag the
      Target Employer Contribution
       column to the
      Slice Size Definition
       list for
      Series 1
      . Report Designer inserts the
      row ["Target_Employer_Contribution"]
       expression as the
      Series 1
       value.
    9. Select and drag the
      Total Compensation Item
       column to the
      Category Definition
       list.
    10. Click
      Next
      .
    11. On the
      Format Chart
       tab, format these values for the
      Series
       chart type:
      Field
      Value
      Value Series
      Delete the
      Series 1
       title.
      Value Series
      Labels
      Configure the
      Fonts
       field to:
      • Font size
        6
        .
      • Bold formatting
        B
        .
    12. On the
      Format Chart
       tab, format these values for the
      Chart Area
       chart type:
      Field
      Value
      Title
      Your Estimated Awards
      Plot
      Configure these
      Area Format
       settings:
      • Anchor:
        Top Left
        .
      • Stretch:
        Vertical
        .
      • Insets (Points): Set all values to
        0
        .
      Legend
      Layout
      Configure these settings:
      • Orientation:
        Vertical
        .
      • Position:
        Left
        .
      • Anchor:
        Middle
        .
      • Insets (Points): Set all values to
        0
        .
      Legend
      Entries
      Configure the
      Fonts
       field to:
      • Font size
        6
        .
      • Bold formatting
        B
        .
    13. Click
      Apply
       and
      Finish
      .
    14. Name the grid
      Grid 2
       and save your work.
  12. Add
    Grid 3
     to the table:
    1. Insert a grid with 3 columns and 2 rows.
    2. Add a background color to the first column of the grid:
      Field
      Value
      Property Editor - Column
      Background color
      Define Custom Colors
      Add these colors to
      Custom Colors
      :
      • Red:
        11
        .
      • Green:
        109
        .
      • Blue:
        168
        .
      Property Editor - Row
      Border
      Color
      • Custom colors:
        RGB (11, 109, 168)
        .
      • Border:
        All Borders
        .
      You can always resize the column to create a narrow colored strip by dragging the column handle.
    3. In the
      Outline
       view, right-click the second cell of the first row, then select
      Insert Element
      .
    4. Double-click the
      Dynamic Text
       option and enter this text:
      row["Year"] + " Base Salary"
    5. In the
      Property Editor - Dynamic Text
       view, configure bold formatting and select the
      12
       font size.
    6. In the
      Outline
       view, expand
      Data Sets
      Workers
       and drag the
      ER Base Pay Total
       field to the third column, first row of the grid.
    7. In the
      Property Editor - Data
       view, configure bold formatting, right alignment, and select the
      12
       font size.
    8. In the
      Outline
       view, right-click the second cell of the second row, then select
      Insert Element
      .
    9. Double-click
      Label
       and enter this text:
      Base pay calculated for January 1 to December 31:
    10. In the
      Property Editor - Label
       view, configure the
      Inline
       display setting and select the
      9
       font size.
    11. In the
      Outline
       view, expand
      Data Sets
      Workers
       and drag the
      ER Base Pay Total
       field to the second column, second row of the grid, just after the previous label.
    12. In the
      Property Editor - Data
       view, configure the
      Inline
       display setting and select the
      9
       font size.
    13. In the
      Property Editor - Grid
       view, specify the
      12
       bottom margin value.
    14. Name the grid
      Grid 3
       and save your work.
  13. Add
    Grid 4
     to the table:
    1. Insert a grid with 3 columns and 3 rows.
    2. As before, add a background color to the first column of the grid:
      Field
      Value
      Property Editor - Column
      Background color
      Green
      Property Editor - Row
      Border
      • Color:
        Green
        .
      • Border:
        All Borders
        .
    3. As before, add the dynamic text to the second cell, first row of the grid:
      "Employer Allowance Contribution for " + row["Year"]
    4. Configure bold formatting and select the
      12
       font size.
    5. In the
      Outline
       view, expand
      Data Sets
      Workers
       and drag the
      ER Allowances Total
       field to the third column, first row of the grid.
    6. Configure bold formatting and select the
      12
       font size.
    7. Add this dynamic text to the second cell, second row of the grid:
      "Your Total Employer Allowance Plan Contribution was: " + row["ER_Allowances_Total"]
    8. In the
      Property Editor - Dynamic Text
       view, select the
      9
       font size and the
      6
       bottom padding value.
    9. Add this dynamic text to the second cell, third row of the grid:
      "Your Contribution to your Allowance Plan was: " + row["EE_Allowances_Total"]
    10. In the
      Property Editor - Dynamic Text
       view, select the
      9
       font size, the
      6
       bottom padding value, and the
      12
       bottom margin value.
    11. Name the grid
      Grid 4
       and save your work.
  14. Add
    Grid 5
     to the table:
    1. Insert a grid with 3 columns and 3 rows.
    2. Add a background color to the first column of the grid:
      Field
      Value
      Property Editor - Column
      Background color
      Define Custom Colors
      Add these colors to
      Custom Colors
      :
      • Red:
        251
        .
      • Green:
        155
        .
      • Blue:
        26
        .
      Property Editor - Row
      Border
      Color
      • Custom colors:
        RGB (251, 155, 26)
        .
      • Border:
        All Borders
        .
    3. Add this dynamic text to the second cell, first row of the grid:
      "Employer Benefit Contribution for " + row["Year"]
    4. Configure bold formatting and select the
      12
       font size.
    5. In the
      Outline
       view, expand
      Data Sets
      Workers
       and drag the
      ER Benefits Total
       field to the third column, first row of the grid.
    6. In the
      Property Editor - Data
       view, configure bold formatting, right alignment, and select the
      12
       font size.
    7. Add this dynamic text to the second cell, second row of the grid:
      "Your Total Employer Benefit Plan Contribution was: " + row["ER_Benefits_Total"]
    8. In the
      Property Editor - Dynamic Text
       view, select the
      9
       font size and
      6
       bottom padding.
    9. Add this dynamic text to the second cell, third row of the grid:
      "Your Contribution to your Benefit Plan was: " + row["EE_Benefits_Total"]
    10. In the
      Property Editor - Dynamic Text
       view, select the
      9
       font size, the
      6
       bottom padding value, and the
      12
       bottom margin value.
    11. Name the grid
      Grid 5
       and save your work.
  15. Add
    Grid 6
     to the table:
    1. Insert a grid with 3 columns and 3 rows.
    2. Add a background color to the first column of the grid:
      Field
      Value
      Property Editor - Column
      Background color
      Red
      Property Editor - Row
      Border
      • Color:
        Red
        .
      • Border:
        All Borders
        .
    3. Add this dynamic text to the second cell, first row of the grid:
      "Target " + row["Year"] + " Management Incentive Plan Award"
    4. Configure bold formatting and select the
      12
       font size.
    5. In the
      Outline
       view, expand
      Data Sets
      Workers
       and drag the
      ER Incentive Total
       field to the third column, first row of the grid.
    6. In the
      Property Editor - Data
       view, configure bold formatting, right alignment, and select the
      12
       font size.
    7. Add this dynamic text to the second cell, second row of the grid:
      "Your Target Award is calculated using the estimated " + row["Year"] + " Base Salary shown above."
    8. In the
      Property Editor - Dynamic Text
       view, select the
      9
       font size and
      6
       bottom padding.
    9. Add this dynamic text to the second cell, third row of the grid:
      "Your current Target Award as a percentage of Base Salary is: " + row["Bonus_Target_Percent"] + row["Percent_Sign"]
    10. In the
      Property Editor - Dynamic Text
       view, select the
      9
       font size, the
      6
       bottom padding value, and the
      12
       bottom margin value.
    11. Name the grid
      Grid 6
       and save your work.
  16. Add
    Grid 7
     to the table:
    1. Insert a grid with 2 columns and 1 row.
    2. Add a background color to the first column of the grid:
      Field
      Value
      Property Editor - Column
      Background color
      Define Custom Colors
      Add these colors to
      Custom Colors
      :
      • Red:
        255
        .
      • Green:
        223
        .
      • Blue:
        223
        .
      Property Editor - Row
      Border
      Color
      • Custom colors:
        RGB (255, 223, 223)
        .
      • Border:
        All Borders
        .
    3. Add this dynamic text to the first cell of the grid:
      "Total Estimated " +row["Year"] + " Compensation"
    4. In the
      Outline
       view, expand
      Data Sets
      Workers
       and drag the
      Total Compensation Amount
       field to the second column of the grid.
    5. In the
      Property Editor - Data
       view, configure bold formatting, right alignment, and select the
      12
       font size.
    6. Name the grid
      Grid 7
       and save your work.
  17. To remove extra pages from the end of the report, modify the report layout preferences:
    1. In the
      Outline
       view, select the
      My Employee Total Rewards.rptdesign
       top-level report design node.
    2. In the
      Property Editor - Report
       view, select the
      Auto Layout
       layout preference.
  18. Save and preview your design.
Deploy your design to Workday for use as a business form layout.