IntroductionRoadmap to CloudBees Flow APIsUsing the CloudBees Flow Perl APICloudBees Flow Perl API Response and Element GlossaryUsing the CloudBees Flow RESTful APIUsing the Flow DSLUsing the CloudBees Flow Groovy APIUsing JRubyCloudBees Flow Error MessagesCloudBees Flow Perl API Response and Element Glossary
IntroductionACL ManagementApplication DependencyApplicationsApplication Tier Artifact ManagementCatalogsChange HistoryComponentsCredential ManagementCustom FiltersDatabase ConfigurationData RetentionDevOps InsightDirectory Provider ManagementDynamic EnvironmentsEmail Configuration ManagementEmail Notifier ManagementEnvironmentEnvironment TierGateway and Zone ManagementInstalling or Upgrading Remote AgentsJob ManagementMicroservicesObject TagsParameter ManagementPersonasPipelines and ReleasesPlugin ManagementProcedure ManagementProcessProcess DependencyProcess StepProject ManagementProperty ManagementResource ManagementRolling DeploySchedule ManagementServer ManagementSingle Sign-OnSnapshotsTier MapUser and Group ManagementWait DependenciesWebhhook ManagementWorkflow Definition ManagementWorkflow ManagementWork ItemsWorkspace ManagementMiscellaneous Management
IntroductionExamples
Introductionaclaclentryactualparameteractualparametersappdepapplicationappservicemappingapptierarchiveconnectorartifactartifactversioncatalogcatalogitemclustercomponentcontainercredentialdashboarddashboardcolumndataretentiondeployerappdeployerconfdeployerservicedeployhistorydirproviderdoisdatasourceemailconfigemailnotifierentitychangeenvinvenvironmentenvmapenvtemeplateenvtemptierenvtemptiermapenvtemptiermappingenvtemptierresourcemappingenvtierenvvareventsubflowruntimeformaloutparamformalparamgategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparampersonapersonacatpersonapagepipelinepipelinerunnamepluginportprocdependprocedureprocessprocstepprojectpropertyreleasereportreportfilterreportobjassocreportobjattrreportobjtyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartrollingrundiscoverysamlidentitysamlserviceschedulesearchfilterserverserviceserviceacctserviceclusterservicedepservicemapsessionsnapshotstagestatestatedeftagtasktiermaptiermappingtransdeftransitionuserutilitywaitdependwidgetwidgetfilteroverrideworkdefworkflowworkitemworkspacezone
Groovy API argument models

DevOps Insight

30 minute readReference
On this page

Dashboard Commands

createDashboard

Creates a new dashboard for the specified project.

You must specify projectName and dashboardName.

Arguments Descriptions

projectName

Name of the project. This name must be unique among all projects.

Argument Type: String

dashboardName

Unique name of the dashboard within the projectName.

Argument Type: String

columns

(Optional) List of the columns to display for the dashboard of type COMMAND_CENTER.

Argument Type: String

description

(Optional) Comment text describing this object; not interpreted at all by CloudBees Flow.

Argument Type: String

layout

(Optional) Layout to use for adding the widgets to the dashboard. Use FLOW.

Argument Type: DashboardLayout

phases

(Optional) List of the phases to display for the dashboard of type COMMAND_CENTER.

This argument is deprecated and is replaced by columns.

Argument Type: String

type

(Optional) Type of dashboard. Allowed types: COMMAND_CENTER or STANDARD. If not specified, STANDARD is used.

Argument Type: DashboardType

Positional arguments

projectName, dashboardName

Response

Returns a dashboard object.

ec-perl

syntax: $<object>->createDashboard(<projectName>, <dashboardName>, {<optionals>});

Example
$ec->createDashboard("Default", "Executive Overview", {description => "Activity at a glance"});