Skip to main content
Administrator Guide
Last Updated: 2023-06-23
Concept: Custom Worklets

Concept: Custom Worklets

You can deploy these types of custom reports as worklets on dashboards or landing pages:
  • Advanced
  • Composite
  • Matrix
  • nBox
  • Transposed
  • Trending

Design Considerations

Workday recommends that you design worklets to load quickly so that they don't time out on a dashboard.
For reports with prompts, Workday recommends that you configure required prompts so that report results display as soon as the dashboard loads:
  • Select
    Do Not Prompt at Runtime
    for required prompt fields.
  • Set default prompt values for all required prompt fields.
To maximize available space for a worklet, Workday recommends that you:
  • Select the
    Display this Worklet When Maximized
    option for nonessential fields in the report definition.
  • Sort and filter the report to display the most essential data.
  • Use charts to visualize and display more data in a worklet.

Sharing Options

When you share a report that you enable as a worklet, users can add the report as a worklet to available dashboards. Example: You can build a headcount report, enable it as a worklet on an HR dashboard, and share it with the HR Partner group. HR Partners can then view the report as a worklet on the HR dashboard.
When you share a report with specific users:
  • You can't add it as a worklet to a dashboard.
  • Your Setup Administrator can't add it as a required or recommended worklet to a landing page.

Optional and Required Worklets

You can add a custom report to a dashboard as:
  • Optional worklets, which users can remove from the dashboard. They can also add optional worklets back to the dashboard.
  • Required worklets, which users can't remove from the dashboard.
If there's a conflict between required and optional options for a worklet, the required option always takes precedence.

Worklet Management

You can't hide or delete a worklet unless you remove it from all dashboards and administrator and user configurations.
You can use the
Remove Worklet from Dashboards
task to remove a worklet from dashboards and configurations. You can select specific dashboards to remove the worklet from or remove the worklet from all dashboards.
The
Remove Worklet from Dashboards
task also includes a confirmation page, which enables you to drill down on worklet usage details for user and administrator configurations.

iPad Considerations

When displaying custom reports and worklets on an iPad, Workday ignores options for:
  • 3D charts.
  • Hiding table borders and column headings.
  • Maximizing reports.
  • Refreshing data. The data refreshes every time you access the report or worklet.