Dashboard View¶
The view dashboard module handles creating Jenkins Dashboard views.
To create a dashboard view specify dashboard in the view-type
attribute to the Dashboard View definition.
Requires the Jenkins Dashboard View.
- View Parameters:
name (str): The name of the view.
view-type (str): The type of view (
dashboard).description (str): A description of the view. (default ‘’)
filter-executors (bool): Show only executors that can execute the included views. (default false)
filter-queue (bool): Show only included jobs in the build queue. (default false)
job-name (list): List of jobs to be included in the view.
job-filters (dict): Job filters to be included. Requires View Job Filters. See List View for supported filter types.
columns (list): List of columns to show. (default: status, weather, job, last-success, last-failure, last-duration, build-button)
regex (str): Regular expression for selecting jobs. (optional)
recurse (bool): Recurse into subfolders. (default false)
status-filter (bool): Filter job list by enabled/disabled status. (optional)
include-std-job-list (bool): Show the standard Jenkins job list at the top of the dashboard. (default false)
hide-jenkins-panels (bool): Hide the standard Jenkins top/side panels for a full-screen dashboard view. (default false)
use-css-style (bool): Use the dashboard CSS styling. (default false)
left-portlet-width (str): CSS width of the left portlet column. (default ‘50%’)
right-portlet-width (str): CSS width of the right portlet column. (default ‘50%’)
top-portlets (list): Portlets to display across the top.
left-portlets (list): Portlets to display in the left column.
right-portlets (list): Portlets to display in the right column.
bottom-portlets (list): Portlets to display across the bottom.
- Portlet types and their parameters:
hudson-std-jobs - Standard Jenkins jobs list portlet.
- portlet-params:
name (str): Display name for the portlet.
jobs-grid - Jobs grid portlet showing jobs in a grid layout.
- portlet-params:
name (str): Display name for the portlet.
column-count (int): Number of columns. (default 3)
fill-column-first (bool): Fill columns before rows. (default false)
unstable-jobs - Lists unstable (and optionally failed) jobs.
- portlet-params:
name (str): Display name for the portlet.
show-only-failed-jobs (bool): Show only failed jobs instead of all unstable jobs. (default false)
recurse (bool): Recurse into subfolders. (default false)
iframe - Embeds an external page via an iframe.
- portlet-params:
name (str): Display name for the portlet.
iframe-source (str): URL of the page to embed. (default ‘’)
div-style (str): Inline CSS style applied to the container div (e.g.
width:100%;height:500px;). (default ‘’)
image - Displays an image from a URL.
- portlet-params:
name (str): Display name for the portlet.
image-url (str): URL of the image to display. (default ‘’)
latest-builds - Shows the most recent builds across all jobs in the view.
- portlet-params:
name (str): Display name for the portlet.
num-builds (int): Number of builds to show. (default 10)
test-statistics-chart - Pie chart of passing/failing/skipped test results.
- portlet-params:
name (str): Display name for the portlet.
test-statistics-grid - Grid showing per-job test statistics.
- portlet-params:
name (str): Display name for the portlet.
hide-zero-test-projects (bool): Hide jobs with no tests. (default false)
success-color (str): Hex color for passing tests, without
#. (default ‘71E66D’)failure-color (str): Hex color for failing tests, without
#. (default ‘E86850’)skipped-color (str): Hex color for skipped tests, without
#. (default ‘FDB813’)use-background-colors (bool): Use background colors in the grid cells. (default false)
use-alternate-percentages-on-limits (bool): Use alternate percentage display at limits. (default false)
test-trend-chart - Line chart of aggregated test results over time.
- portlet-params:
name (str): Display name for the portlet.
graph-width (int): Chart width in pixels. (default 300)
graph-height (int): Chart height in pixels. (default 220)
date-range (int): Number of days of history to show. (default 365)
date-shift (int): Shift start of date range by this many days. (default 0)
display-status (str): Which test results to include. (default ‘ALL’)
stat-jobs - Shows statistics based on job health scores.
- portlet-params:
name (str): Display name for the portlet.
stat-builds - Shows statistics based on build status.
- portlet-params:
name (str): Display name for the portlet.
stat-slaves - Shows agent/node statistics.
- portlet-params:
name (str): Display name for the portlet.
Minimal Example:
name: Test Dashboard view-type: dashboard
Full Example:
name: Test Dashboard description: A full dashboard view view-type: dashboard include-std-job-list: true hide-jenkins-panels: true use-css-style: true left-portlet-width: "60%" right-portlet-width: "40%" job-name: - job-A - job-B regex: ".*" recurse: true top-portlets: - type: stat-builds name: Build Statistics - type: stat-slaves name: Agent Statistics - type: latest-builds name: Latest Builds num-builds: 5 left-portlets: - type: iframe name: Iframe Portlet iframe-source: "https://example.com" div-style: "width:100%;height:500px;" - type: image name: Image Portlet image-url: "https://example.com/image.png" right-portlets: - type: hudson-std-jobs name: Jenkins Jobs List - type: jobs-grid name: Jobs Grid column-count: 3 fill-column-first: false - type: unstable-jobs name: Unstable Jobs show-only-failed-jobs: false recurse: false - type: stat-jobs name: Job Statistics bottom-portlets: - type: test-statistics-chart name: Test Statistics Chart - type: test-statistics-grid name: Test Statistics Grid hide-zero-test-projects: false success-color: "71E66D" failure-color: "E86850" skipped-color: "FDB813" use-background-colors: false use-alternate-percentages-on-limits: false - type: test-trend-chart name: Test Trend Chart graph-width: 300 graph-height: 220 date-range: 365 date-shift: 0 display-status: ALL